1. Registry
  2. Packages
  3. Google Cloud Native
  4. API Docs
  5. toolresults
  6. toolresults/v1beta3
  7. PerfSampleSeries

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

    Create PerfSampleSeries Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PerfSampleSeries(name: string, args: PerfSampleSeriesArgs, opts?: CustomResourceOptions);
    @overload
    def PerfSampleSeries(resource_name: str,
                         args: PerfSampleSeriesArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def PerfSampleSeries(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         execution_id: Optional[str] = None,
                         history_id: Optional[str] = None,
                         step_id: Optional[str] = None,
                         basic_perf_sample_series: Optional[BasicPerfSampleSeriesArgs] = None,
                         project: Optional[str] = None)
    func NewPerfSampleSeries(ctx *Context, name string, args PerfSampleSeriesArgs, opts ...ResourceOption) (*PerfSampleSeries, error)
    public PerfSampleSeries(string name, PerfSampleSeriesArgs args, CustomResourceOptions? opts = null)
    public PerfSampleSeries(String name, PerfSampleSeriesArgs args)
    public PerfSampleSeries(String name, PerfSampleSeriesArgs args, CustomResourceOptions options)
    
    type: google-native:toolresults/v1beta3:PerfSampleSeries
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_toolresults_v1beta3_perf_sample_series" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PerfSampleSeriesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PerfSampleSeriesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PerfSampleSeriesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PerfSampleSeriesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PerfSampleSeriesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var perfSampleSeriesResource = new GoogleNative.ToolResults.V1Beta3.PerfSampleSeries("perfSampleSeriesResource", new()
    {
        ExecutionId = "string",
        HistoryId = "string",
        StepId = "string",
        BasicPerfSampleSeries = new GoogleNative.ToolResults.V1Beta3.Inputs.BasicPerfSampleSeriesArgs
        {
            PerfMetricType = GoogleNative.ToolResults.V1Beta3.BasicPerfSampleSeriesPerfMetricType.PerfMetricTypeUnspecified,
            PerfUnit = GoogleNative.ToolResults.V1Beta3.BasicPerfSampleSeriesPerfUnit.PerfUnitUnspecified,
            SampleSeriesLabel = GoogleNative.ToolResults.V1Beta3.BasicPerfSampleSeriesSampleSeriesLabel.SampleSeriesTypeUnspecified,
        },
        Project = "string",
    });
    
    example, err := toolresults.NewPerfSampleSeries(ctx, "perfSampleSeriesResource", &toolresults.PerfSampleSeriesArgs{
    	ExecutionId: pulumi.String("string"),
    	HistoryId:   pulumi.String("string"),
    	StepId:      pulumi.String("string"),
    	BasicPerfSampleSeries: &toolresults.BasicPerfSampleSeriesArgs{
    		PerfMetricType:    toolresults.BasicPerfSampleSeriesPerfMetricTypePerfMetricTypeUnspecified,
    		PerfUnit:          toolresults.BasicPerfSampleSeriesPerfUnitPerfUnitUnspecified,
    		SampleSeriesLabel: toolresults.BasicPerfSampleSeriesSampleSeriesLabelSampleSeriesTypeUnspecified,
    	},
    	Project: pulumi.String("string"),
    })
    
    resource "google-native_toolresults_v1beta3_perf_sample_series" "perfSampleSeriesResource" {
      lifecycle {
        create_before_destroy = true
      }
      execution_id = "string"
      history_id   = "string"
      step_id      = "string"
      basic_perf_sample_series = {
        perf_metric_type    = "perfMetricTypeUnspecified"
        perf_unit           = "perfUnitUnspecified"
        sample_series_label = "sampleSeriesTypeUnspecified"
      }
      project = "string"
    }
    
    var perfSampleSeriesResource = new PerfSampleSeries("perfSampleSeriesResource", PerfSampleSeriesArgs.builder()
        .executionId("string")
        .historyId("string")
        .stepId("string")
        .basicPerfSampleSeries(BasicPerfSampleSeriesArgs.builder()
            .perfMetricType(com.pulumi.googlenative.toolresults_v1beta3.enums.BasicPerfSampleSeriesPerfMetricType.PerfMetricTypeUnspecified)
            .perfUnit(com.pulumi.googlenative.toolresults_v1beta3.enums.BasicPerfSampleSeriesPerfUnit.PerfUnitUnspecified)
            .sampleSeriesLabel(com.pulumi.googlenative.toolresults_v1beta3.enums.BasicPerfSampleSeriesSampleSeriesLabel.SampleSeriesTypeUnspecified)
            .build())
        .project("string")
        .build());
    
    perf_sample_series_resource = google_native.toolresults.v1beta3.PerfSampleSeries("perfSampleSeriesResource",
        execution_id="string",
        history_id="string",
        step_id="string",
        basic_perf_sample_series={
            "perf_metric_type": google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfMetricType.PERF_METRIC_TYPE_UNSPECIFIED,
            "perf_unit": google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfUnit.PERF_UNIT_UNSPECIFIED,
            "sample_series_label": google_native.toolresults.v1beta3.BasicPerfSampleSeriesSampleSeriesLabel.SAMPLE_SERIES_TYPE_UNSPECIFIED,
        },
        project="string")
    
    const perfSampleSeriesResource = new google_native.toolresults.v1beta3.PerfSampleSeries("perfSampleSeriesResource", {
        executionId: "string",
        historyId: "string",
        stepId: "string",
        basicPerfSampleSeries: {
            perfMetricType: google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfMetricType.PerfMetricTypeUnspecified,
            perfUnit: google_native.toolresults.v1beta3.BasicPerfSampleSeriesPerfUnit.PerfUnitUnspecified,
            sampleSeriesLabel: google_native.toolresults.v1beta3.BasicPerfSampleSeriesSampleSeriesLabel.SampleSeriesTypeUnspecified,
        },
        project: "string",
    });
    
    type: google-native:toolresults/v1beta3:PerfSampleSeries
    properties:
        basicPerfSampleSeries:
            perfMetricType: perfMetricTypeUnspecified
            perfUnit: perfUnitUnspecified
            sampleSeriesLabel: sampleSeriesTypeUnspecified
        executionId: string
        historyId: string
        project: string
        stepId: string
    

    PerfSampleSeries Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PerfSampleSeries resource accepts the following input properties:

    ExecutionId string
    HistoryId string
    StepId string
    BasicPerfSampleSeries BasicPerfSampleSeriesArgs
    Basic series represented by a line chart
    Project string
    execution_id string
    history_id string
    step_id string
    basic_perf_sample_series object
    Basic series represented by a line chart
    project string
    executionId String
    historyId String
    stepId String
    basicPerfSampleSeries BasicPerfSampleSeries
    Basic series represented by a line chart
    project String
    executionId string
    historyId string
    stepId string
    basicPerfSampleSeries BasicPerfSampleSeries
    Basic series represented by a line chart
    project string
    execution_id str
    history_id str
    step_id str
    basic_perf_sample_series BasicPerfSampleSeriesArgs
    Basic series represented by a line chart
    project str
    executionId String
    historyId String
    stepId String
    basicPerfSampleSeries Property Map
    Basic series represented by a line chart
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PerfSampleSeries resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    SampleSeriesId string
    A sample series id
    Id string
    The provider-assigned unique ID for this managed resource.
    SampleSeriesId string
    A sample series id
    id string
    The provider-assigned unique ID for this managed resource.
    sample_series_id string
    A sample series id
    id String
    The provider-assigned unique ID for this managed resource.
    sampleSeriesId String
    A sample series id
    id string
    The provider-assigned unique ID for this managed resource.
    sampleSeriesId string
    A sample series id
    id str
    The provider-assigned unique ID for this managed resource.
    sample_series_id str
    A sample series id
    id String
    The provider-assigned unique ID for this managed resource.
    sampleSeriesId String
    A sample series id

    Look up Existing PerfSampleSeries Resource

    Get an existing PerfSampleSeries resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): PerfSampleSeries
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> PerfSampleSeries
    func GetPerfSampleSeries(ctx *Context, name string, id IDInput, state *PerfSampleSeriesState, opts ...ResourceOption) (*PerfSampleSeries, error)
    public static PerfSampleSeries Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static PerfSampleSeries get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingPerfSampleSeries:    type: google-native:toolresults/v1beta3:PerfSampleSeries    get:      id: ${id}
    import {
      to = google-native_toolresults_v1beta3_perf_sample_series.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state PerfSampleSeriesState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    BasicPerfSampleSeries, BasicPerfSampleSeriesArgs

    Encapsulates the metadata for basic sample series represented by a line chart

    BasicPerfSampleSeriesPerfMetricType

    NameValue
    PerfMetricTypeUnspecifiedperfMetricTypeUnspecified
    Memorymemory
    Cpucpu
    Networknetwork
    Graphicsgraphics
    NameValue
    BasicPerfSampleSeriesPerfMetricTypePerfMetricTypeUnspecifiedperfMetricTypeUnspecified
    BasicPerfSampleSeriesPerfMetricTypeMemorymemory
    BasicPerfSampleSeriesPerfMetricTypeCpucpu
    BasicPerfSampleSeriesPerfMetricTypeNetworknetwork
    BasicPerfSampleSeriesPerfMetricTypeGraphicsgraphics
    Value
    perfMetricTypeUnspecified
    memory
    cpu
    network
    graphics
    NameValue
    PerfMetricTypeUnspecifiedperfMetricTypeUnspecified
    Memorymemory
    Cpucpu
    Networknetwork
    Graphicsgraphics
    NameValue
    PerfMetricTypeUnspecifiedperfMetricTypeUnspecified
    Memorymemory
    Cpucpu
    Networknetwork
    Graphicsgraphics
    NameValue
    PERF_METRIC_TYPE_UNSPECIFIEDperfMetricTypeUnspecified
    MEMORYmemory
    CPUcpu
    NETWORKnetwork
    GRAPHICSgraphics
    Value
    perfMetricTypeUnspecified
    memory
    cpu
    network
    graphics

    BasicPerfSampleSeriesPerfUnit

    NameValue
    PerfUnitUnspecifiedperfUnitUnspecified
    Kibibytekibibyte
    Percentpercent
    BytesPerSecondbytesPerSecond
    FramesPerSecondframesPerSecond
    Bytebyte
    NameValue
    BasicPerfSampleSeriesPerfUnitPerfUnitUnspecifiedperfUnitUnspecified
    BasicPerfSampleSeriesPerfUnitKibibytekibibyte
    BasicPerfSampleSeriesPerfUnitPercentpercent
    BasicPerfSampleSeriesPerfUnitBytesPerSecondbytesPerSecond
    BasicPerfSampleSeriesPerfUnitFramesPerSecondframesPerSecond
    BasicPerfSampleSeriesPerfUnitBytebyte
    Value
    perfUnitUnspecified
    kibibyte
    percent
    bytesPerSecond
    framesPerSecond
    byte
    NameValue
    PerfUnitUnspecifiedperfUnitUnspecified
    Kibibytekibibyte
    Percentpercent
    BytesPerSecondbytesPerSecond
    FramesPerSecondframesPerSecond
    Bytebyte
    NameValue
    PerfUnitUnspecifiedperfUnitUnspecified
    Kibibytekibibyte
    Percentpercent
    BytesPerSecondbytesPerSecond
    FramesPerSecondframesPerSecond
    Bytebyte
    NameValue
    PERF_UNIT_UNSPECIFIEDperfUnitUnspecified
    KIBIBYTEkibibyte
    PERCENTpercent
    BYTES_PER_SECONDbytesPerSecond
    FRAMES_PER_SECONDframesPerSecond
    BYTEbyte
    Value
    perfUnitUnspecified
    kibibyte
    percent
    bytesPerSecond
    framesPerSecond
    byte

    BasicPerfSampleSeriesResponse

    Encapsulates the metadata for basic sample series represented by a line chart

    BasicPerfSampleSeriesSampleSeriesLabel

    NameValueDescription
    SampleSeriesTypeUnspecifiedsampleSeriesTypeUnspecified
    MemoryRssPrivatememoryRssPrivateMemory sample series
    MemoryRssSharedmemoryRssShared
    MemoryRssTotalmemoryRssTotal
    MemoryTotalmemoryTotal
    CpuUsercpuUserCPU sample series
    CpuKernelcpuKernel
    CpuTotalcpuTotal
    NtBytesTransferredntBytesTransferredNetwork sample series
    NtBytesReceivedntBytesReceived
    NetworkSentnetworkSent
    NetworkReceivednetworkReceived
    GraphicsFrameRategraphicsFrameRateGraphics sample series
    NameValueDescription
    BasicPerfSampleSeriesSampleSeriesLabelSampleSeriesTypeUnspecifiedsampleSeriesTypeUnspecified
    BasicPerfSampleSeriesSampleSeriesLabelMemoryRssPrivatememoryRssPrivateMemory sample series
    BasicPerfSampleSeriesSampleSeriesLabelMemoryRssSharedmemoryRssShared
    BasicPerfSampleSeriesSampleSeriesLabelMemoryRssTotalmemoryRssTotal
    BasicPerfSampleSeriesSampleSeriesLabelMemoryTotalmemoryTotal
    BasicPerfSampleSeriesSampleSeriesLabelCpuUsercpuUserCPU sample series
    BasicPerfSampleSeriesSampleSeriesLabelCpuKernelcpuKernel
    BasicPerfSampleSeriesSampleSeriesLabelCpuTotalcpuTotal
    BasicPerfSampleSeriesSampleSeriesLabelNtBytesTransferredntBytesTransferredNetwork sample series
    BasicPerfSampleSeriesSampleSeriesLabelNtBytesReceivedntBytesReceived
    BasicPerfSampleSeriesSampleSeriesLabelNetworkSentnetworkSent
    BasicPerfSampleSeriesSampleSeriesLabelNetworkReceivednetworkReceived
    BasicPerfSampleSeriesSampleSeriesLabelGraphicsFrameRategraphicsFrameRateGraphics sample series
    ValueDescription
    sampleSeriesTypeUnspecified
    memoryRssPrivateMemory sample series
    memoryRssShared
    memoryRssTotal
    memoryTotal
    cpuUserCPU sample series
    cpuKernel
    cpuTotal
    ntBytesTransferredNetwork sample series
    ntBytesReceived
    networkSent
    networkReceived
    graphicsFrameRateGraphics sample series
    NameValueDescription
    SampleSeriesTypeUnspecifiedsampleSeriesTypeUnspecified
    MemoryRssPrivatememoryRssPrivateMemory sample series
    MemoryRssSharedmemoryRssShared
    MemoryRssTotalmemoryRssTotal
    MemoryTotalmemoryTotal
    CpuUsercpuUserCPU sample series
    CpuKernelcpuKernel
    CpuTotalcpuTotal
    NtBytesTransferredntBytesTransferredNetwork sample series
    NtBytesReceivedntBytesReceived
    NetworkSentnetworkSent
    NetworkReceivednetworkReceived
    GraphicsFrameRategraphicsFrameRateGraphics sample series
    NameValueDescription
    SampleSeriesTypeUnspecifiedsampleSeriesTypeUnspecified
    MemoryRssPrivatememoryRssPrivateMemory sample series
    MemoryRssSharedmemoryRssShared
    MemoryRssTotalmemoryRssTotal
    MemoryTotalmemoryTotal
    CpuUsercpuUserCPU sample series
    CpuKernelcpuKernel
    CpuTotalcpuTotal
    NtBytesTransferredntBytesTransferredNetwork sample series
    NtBytesReceivedntBytesReceived
    NetworkSentnetworkSent
    NetworkReceivednetworkReceived
    GraphicsFrameRategraphicsFrameRateGraphics sample series
    NameValueDescription
    SAMPLE_SERIES_TYPE_UNSPECIFIEDsampleSeriesTypeUnspecified
    MEMORY_RSS_PRIVATEmemoryRssPrivateMemory sample series
    MEMORY_RSS_SHAREDmemoryRssShared
    MEMORY_RSS_TOTALmemoryRssTotal
    MEMORY_TOTALmemoryTotal
    CPU_USERcpuUserCPU sample series
    CPU_KERNELcpuKernel
    CPU_TOTALcpuTotal
    NT_BYTES_TRANSFERREDntBytesTransferredNetwork sample series
    NT_BYTES_RECEIVEDntBytesReceived
    NETWORK_SENTnetworkSent
    NETWORK_RECEIVEDnetworkReceived
    GRAPHICS_FRAME_RATEgraphicsFrameRateGraphics sample series
    ValueDescription
    sampleSeriesTypeUnspecified
    memoryRssPrivateMemory sample series
    memoryRssShared
    memoryRssTotal
    memoryTotal
    cpuUserCPU sample series
    cpuKernel
    cpuTotal
    ntBytesTransferredNetwork sample series
    ntBytesReceived
    networkSent
    networkReceived
    graphicsFrameRateGraphics sample series

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo Google Cloud Native

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial