perf_sample_series

Creates, updates, deletes, gets or lists a perf_sample_series resource.

Overview

Name	perf_sample_series
Type	Resource
Id	firebase.toolresults.perf_sample_series

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
basicPerfSampleSeries	object	Basic series represented by a line chart (id: BasicPerfSampleSeries)
executionId	string	A tool results execution ID. @OutputOnly
historyId	string	A tool results history ID. @OutputOnly
projectId	string	The cloud project @OutputOnly
sampleSeriesId	string	A sample series id @OutputOnly
stepId	string	A tool results step ID. @OutputOnly

list

Successful response

Name	Datatype	Description
perfSampleSeries	array	The resulting PerfSampleSeries sorted by id

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectId, historyId, executionId, stepId, sampleSeriesId		Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist
list	select	projectId, historyId, executionId, stepId	filter	Lists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist
create	insert	projectId, historyId, executionId, stepId		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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
executionId	string
historyId	string
projectId	string
sampleSeriesId	string
stepId	string
filter	string

SELECT examples

get

Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist

SELECT
basicPerfSampleSeries,
executionId,
historyId,
projectId,
sampleSeriesId,
stepId
FROM firebase.toolresults.perf_sample_series
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND executionId = '{{ executionId }}' -- required
AND stepId = '{{ stepId }}' -- required
AND sampleSeriesId = '{{ sampleSeriesId }}' -- required;

list

Lists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist

SELECT
perfSampleSeries
FROM firebase.toolresults.perf_sample_series
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND executionId = '{{ executionId }}' -- required
AND stepId = '{{ stepId }}' -- required
AND filter = '{{ filter }}';

INSERT examples

create

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

INSERT INTO firebase.toolresults.perf_sample_series (
data__projectId,
data__historyId,
data__executionId,
data__stepId,
data__sampleSeriesId,
data__basicPerfSampleSeries,
projectId,
historyId,
executionId,
stepId
)
SELECT 
'{{ projectId }}',
'{{ historyId }}',
'{{ executionId }}',
'{{ stepId }}',
'{{ sampleSeriesId }}',
'{{ basicPerfSampleSeries }}',
'{{ projectId }}',
'{{ historyId }}',
'{{ executionId }}',
'{{ stepId }}'
RETURNING
basicPerfSampleSeries,
executionId,
historyId,
projectId,
sampleSeriesId,
stepId
;

Manifest

# Description fields are for documentation purposes
- name: perf_sample_series
  props:
    - name: projectId
      value: string
      description: Required parameter for the perf_sample_series resource.
    - name: historyId
      value: string
      description: Required parameter for the perf_sample_series resource.
    - name: executionId
      value: string
      description: Required parameter for the perf_sample_series resource.
    - name: stepId
      value: string
      description: Required parameter for the perf_sample_series resource.
    - name: projectId
      value: string
      description: >
        The cloud project @OutputOnly
        
    - name: historyId
      value: string
      description: >
        A tool results history ID. @OutputOnly
        
    - name: executionId
      value: string
      description: >
        A tool results execution ID. @OutputOnly
        
    - name: stepId
      value: string
      description: >
        A tool results step ID. @OutputOnly
        
    - name: sampleSeriesId
      value: string
      description: >
        A sample series id @OutputOnly
        
    - name: basicPerfSampleSeries
      value: object
      description: >
        Basic series represented by a line chart