samples

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

Overview

Name	samples
Type	Resource
Id	firebase.toolresults.samples

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
sampleTime	object	Timestamp of collection. (id: Timestamp)
value	number (double)	Value observed

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectId, historyId, executionId, stepId, sampleSeriesId	pageSize, pageToken	Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist
batch_create	insert	projectId, historyId, executionId, stepId, sampleSeriesId		Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries 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
pageSize	integer (int32)
pageToken	string

SELECT examples

list

Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist

SELECT
sampleTime,
value
FROM firebase.toolresults.samples
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND executionId = '{{ executionId }}' -- required
AND stepId = '{{ stepId }}' -- required
AND sampleSeriesId = '{{ sampleSeriesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

batch_create

Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist

INSERT INTO firebase.toolresults.samples (
data__perfSamples,
projectId,
historyId,
executionId,
stepId,
sampleSeriesId
)
SELECT 
'{{ perfSamples }}',
'{{ projectId }}',
'{{ historyId }}',
'{{ executionId }}',
'{{ stepId }}',
'{{ sampleSeriesId }}'
RETURNING
perfSamples
;

Manifest

# Description fields are for documentation purposes
- name: samples
  props:
    - name: projectId
      value: string
      description: Required parameter for the samples resource.
    - name: historyId
      value: string
      description: Required parameter for the samples resource.
    - name: executionId
      value: string
      description: Required parameter for the samples resource.
    - name: stepId
      value: string
      description: Required parameter for the samples resource.
    - name: sampleSeriesId
      value: string
      description: Required parameter for the samples resource.
    - name: perfSamples
      value: array
      description: >
        The set of PerfSamples to create should not include existing timestamps