REST Resource: projects.histories.executions.steps.perfSampleSeries
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-24 UTC.
[null,null,["Last updated 2024-07-24 UTC."],[],[],null,["# REST Resource: projects.histories.executions.steps.perfSampleSeries\n\n- [Resource: PerfSampleSeries](#PerfSampleSeries)\n - [JSON representation](#PerfSampleSeries.SCHEMA_REPRESENTATION)\n- [BasicPerfSampleSeries](#BasicPerfSampleSeries)\n - [JSON representation](#BasicPerfSampleSeries.SCHEMA_REPRESENTATION)\n- [PerfUnit](#PerfUnit)\n- [SampleSeriesLabel](#SampleSeriesLabel)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PerfSampleSeries\n--------------------------\n\nResource representing a collection of performance samples (or data points)\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"projectId\": string, \"historyId\": string, \"executionId\": string, \"stepId\": string, \"sampleSeriesId\": string, // Union field `perf_sample_series` can be only one of the following: \"basicPerfSampleSeries\": { object (/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries#BasicPerfSampleSeries) } // End of list of possible types for union field `perf_sample_series`. } ``` |\n\n| Fields ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `projectId` | `string` The cloud project Note: This field is used in responses only. Any value specified here in a request is ignored. |\n| `historyId` | `string` A tool results history ID. Note: This field is used in responses only. Any value specified here in a request is ignored. |\n| `executionId` | `string` A tool results execution ID. Note: This field is used in responses only. Any value specified here in a request is ignored. |\n| `stepId` | `string` A tool results step ID. Note: This field is used in responses only. Any value specified here in a request is ignored. |\n| `sampleSeriesId` | `string` A sample series id Note: This field is used in responses only. Any value specified here in a request is ignored. |\n| Union field `perf_sample_series`. `perf_sample_series` can be only one of the following: ||\n| `basicPerfSampleSeries` | `object (`[BasicPerfSampleSeries](/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries#BasicPerfSampleSeries)`)` Basic series represented by a line chart |\n\nBasicPerfSampleSeries\n---------------------\n\nEncapsulates the metadata for basic sample series represented by a line chart\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"perfMetricType\": enum (/docs/test-lab/reference/toolresults/rest/v1beta3/PerfMetricType), \"perfUnit\": enum (/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries#PerfUnit), \"sampleSeriesLabel\": enum (/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries#SampleSeriesLabel) } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `perfMetricType` | `enum (`[PerfMetricType](/docs/test-lab/reference/toolresults/rest/v1beta3/PerfMetricType)`)` |\n| `perfUnit` | `enum (`[PerfUnit](/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries#PerfUnit)`)` |\n| `sampleSeriesLabel` | `enum (`[SampleSeriesLabel](/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries#SampleSeriesLabel)`)` |\n\nPerfUnit\n--------\n\nThe unit corresponding to the series of data points in this collection\n\n| Enums ||\n|-----------------------|---|\n| `perfUnitUnspecified` | |\n| `kibibyte` | |\n| `percent` | |\n| `bytesPerSecond` | |\n| `framesPerSecond` | |\n| `byte` | |\n\nSampleSeriesLabel\n-----------------\n\nLabel to identify a given performance sample series\n\n| Enums ||\n|-------------------------------|------------------------|\n| `sampleSeriesTypeUnspecified` | |\n| `memoryRssPrivate` | Memory sample series |\n| `memoryRssShared` | |\n| `memoryRssTotal` | |\n| `memoryTotal` | |\n| `cpuUser` | CPU sample series |\n| `cpuKernel` | |\n| `cpuTotal` | |\n| `ntBytesTransferred` | Network sample series |\n| `ntBytesReceived` | |\n| `networkSent` | |\n| `networkReceived` | |\n| `graphicsFrameRate` | Graphics sample series |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------------------------------|------------------------------------------|\n| ### [create](/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries/create) | Creates a PerfSampleSeries. |\n| ### [get](/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries/get) | Gets a PerfSampleSeries. |\n| ### [list](/docs/test-lab/reference/toolresults/rest/v1beta3/projects.histories.executions.steps.perfSampleSeries/list) | Lists PerfSampleSeries for a given Step. |"]]
