executions

Creates, updates, deletes, gets or lists an executions resource.

Overview

Name	executions
Type	Resource
Id	firebase.toolresults.executions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
completionTime	object	The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set (id: Timestamp)
creationTime	object	The time when the Execution was created. This value will be set automatically when CreateExecution is called. - In response: always set - In create/update request: never set (id: Timestamp)
dimensionDefinitions	array	The dimensions along which different steps in this execution may vary. This must remain fixed over the life of the execution. Returns INVALID_ARGUMENT if this field is set in an update request. Returns INVALID_ARGUMENT if the same name occurs in more than one dimension_definition. Returns INVALID_ARGUMENT if the size of the list is over 100. - In response: present if set by create - In create request: optional - In update request: never set
executionId	string	A unique identifier within a History for this Execution. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create/update request: never set
outcome	object	Classify the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional (id: Outcome)
specification	object	Lightweight information about execution request. - In response: present if set by create - In create: optional - In update: optional (id: Specification)
state	string	The initial state is IN_PROGRESS. The only legal state transitions is from IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if an invalid transition is requested. The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times. If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE. - In response always set - In create/update request: optional
testExecutionMatrixId	string	TestExecution Matrix ID that the TestExecutionService uses. - In response: present if set by create - In create: optional - In update: never set

list

Successful response

Name	Datatype	Description
completionTime	object	The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set (id: Timestamp)
creationTime	object	The time when the Execution was created. This value will be set automatically when CreateExecution is called. - In response: always set - In create/update request: never set (id: Timestamp)
dimensionDefinitions	array	The dimensions along which different steps in this execution may vary. This must remain fixed over the life of the execution. Returns INVALID_ARGUMENT if this field is set in an update request. Returns INVALID_ARGUMENT if the same name occurs in more than one dimension_definition. Returns INVALID_ARGUMENT if the size of the list is over 100. - In response: present if set by create - In create request: optional - In update request: never set
executionId	string	A unique identifier within a History for this Execution. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create/update request: never set
outcome	object	Classify the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional (id: Outcome)
specification	object	Lightweight information about execution request. - In response: present if set by create - In create: optional - In update: optional (id: Specification)
state	string	The initial state is IN_PROGRESS. The only legal state transitions is from IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if an invalid transition is requested. The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times. If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE. - In response always set - In create/update request: optional
testExecutionMatrixId	string	TestExecution Matrix ID that the TestExecutionService uses. - In response: present if set by create - In create: optional - In update: never set

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectId, historyId, executionId		Gets an Execution. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist
list	select	projectId, historyId	pageToken, pageSize	Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist
create	insert	projectId, historyId	requestId	Creates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist
patch	update	projectId, historyId, executionId	requestId	Updates an existing Execution with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History 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
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets an Execution. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist

SELECT
completionTime,
creationTime,
dimensionDefinitions,
executionId,
outcome,
specification,
state,
testExecutionMatrixId
FROM firebase.toolresults.executions
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND executionId = '{{ executionId }}' -- required;

list

Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist

SELECT
completionTime,
creationTime,
dimensionDefinitions,
executionId,
outcome,
specification,
state,
testExecutionMatrixId
FROM firebase.toolresults.executions
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

create

Creates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist

INSERT INTO firebase.toolresults.executions (
data__executionId,
data__state,
data__creationTime,
data__completionTime,
data__outcome,
data__dimensionDefinitions,
data__specification,
data__testExecutionMatrixId,
projectId,
historyId,
requestId
)
SELECT 
'{{ executionId }}',
'{{ state }}',
'{{ creationTime }}',
'{{ completionTime }}',
'{{ outcome }}',
'{{ dimensionDefinitions }}',
'{{ specification }}',
'{{ testExecutionMatrixId }}',
'{{ projectId }}',
'{{ historyId }}',
'{{ requestId }}'
RETURNING
completionTime,
creationTime,
dimensionDefinitions,
executionId,
outcome,
specification,
state,
testExecutionMatrixId
;

Manifest

# Description fields are for documentation purposes
- name: executions
  props:
    - name: projectId
      value: string
      description: Required parameter for the executions resource.
    - name: historyId
      value: string
      description: Required parameter for the executions resource.
    - name: executionId
      value: string
      description: >
        A unique identifier within a History for this Execution. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create/update request: never set
        
    - name: state
      value: string
      description: >
        The initial state is IN_PROGRESS. The only legal state transitions is from IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if an invalid transition is requested. The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times. If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE. - In response always set - In create/update request: optional
        
      valid_values: ['unknownState', 'pending', 'inProgress', 'complete']
    - name: creationTime
      value: object
      description: >
        The time when the Execution was created. This value will be set automatically when CreateExecution is called. - In response: always set - In create/update request: never set
        
    - name: completionTime
      value: object
      description: >
        The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set
        
    - name: outcome
      value: object
      description: >
        Classify the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional
        
    - name: dimensionDefinitions
      value: array
      description: >
        The dimensions along which different steps in this execution may vary. This must remain fixed over the life of the execution. Returns INVALID_ARGUMENT if this field is set in an update request. Returns INVALID_ARGUMENT if the same name occurs in more than one dimension_definition. Returns INVALID_ARGUMENT if the size of the list is over 100. - In response: present if set by create - In create request: optional - In update request: never set
        
    - name: specification
      value: object
      description: >
        Lightweight information about execution request. - In response: present if set by create - In create: optional - In update: optional
        
    - name: testExecutionMatrixId
      value: string
      description: >
        TestExecution Matrix ID that the TestExecutionService uses. - In response: present if set by create - In create: optional - In update: never set
        
    - name: requestId
      value: string

UPDATE examples

patch

Updates an existing Execution with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist

UPDATE firebase.toolresults.executions
SET 
data__executionId = '{{ executionId }}',
data__state = '{{ state }}',
data__creationTime = '{{ creationTime }}',
data__completionTime = '{{ completionTime }}',
data__outcome = '{{ outcome }}',
data__dimensionDefinitions = '{{ dimensionDefinitions }}',
data__specification = '{{ specification }}',
data__testExecutionMatrixId = '{{ testExecutionMatrixId }}'
WHERE 
projectId = '{{ projectId }}' --required
AND historyId = '{{ historyId }}' --required
AND executionId = '{{ executionId }}' --required
AND requestId = '{{ requestId}}'
RETURNING
completionTime,
creationTime,
dimensionDefinitions,
executionId,
outcome,
specification,
state,
testExecutionMatrixId;