executions

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

Overview

Name	executions
Type	Resource
Id	google.workflowexecutions.executions

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
argument	string	Input parameters of the execution represented as a JSON string. The size limit is 32KB. Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'
callLogLevel	string	The call logging level associated to this execution.
createTime	string (google-datetime)	Output only. Marks the creation of the execution.
disableConcurrencyQuotaOverflowBuffering	boolean	Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available.
duration	string (google-duration)	Output only. Measures the duration of the execution.
endTime	string (google-datetime)	Output only. Marks the end of execution, successful or not.
error	object	Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED. (id: Error)
executionHistoryLevel	string	Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution.
labels	object	Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution.
result	string	Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.
startTime	string (google-datetime)	Output only. Marks the beginning of execution. Note that this will be the same as createTime for executions that start immediately.
state	string	Output only. Current state of the execution.
stateError	object	Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions. (id: StateError)
status	object	Output only. Status tracks the current steps and progress data of this execution. (id: Status)
workflowRevisionId	string	Output only. Revision of the workflow this execution is using.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
argument	string	Input parameters of the execution represented as a JSON string. The size limit is 32KB. Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'
callLogLevel	string	The call logging level associated to this execution.
createTime	string (google-datetime)	Output only. Marks the creation of the execution.
disableConcurrencyQuotaOverflowBuffering	boolean	Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available.
duration	string (google-duration)	Output only. Measures the duration of the execution.
endTime	string (google-datetime)	Output only. Marks the end of execution, successful or not.
error	object	Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED. (id: Error)
executionHistoryLevel	string	Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution.
labels	object	Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution.
result	string	Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.
startTime	string (google-datetime)	Output only. Marks the beginning of execution. Note that this will be the same as createTime for executions that start immediately.
state	string	Output only. Current state of the execution.
stateError	object	Output only. Error regarding the state of the Execution resource. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions. (id: StateError)
status	object	Output only. Status tracks the current steps and progress data of this execution. (id: Status)
workflowRevisionId	string	Output only. Revision of the workflow this execution is using.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, workflowsId, executionsId	view	Returns an execution of the given name.
list	select	projectsId, locationsId, workflowsId	pageSize, pageToken, view, filter, orderBy	Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).
create	insert	projectsId, locationsId, workflowsId		Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.
cancel	exec	projectsId, locationsId, workflowsId, executionsId		Cancels an execution of the given name.
export_data	exec	projectsId, locationsId, workflowsId, executionsId		Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.

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
executionsId	string
locationsId	string
projectsId	string
workflowsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
view	string

SELECT examples

get

Returns an execution of the given name.

SELECT
name,
argument,
callLogLevel,
createTime,
disableConcurrencyQuotaOverflowBuffering,
duration,
endTime,
error,
executionHistoryLevel,
labels,
result,
startTime,
state,
stateError,
status,
workflowRevisionId
FROM google.workflowexecutions.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workflowsId = '{{ workflowsId }}' -- required
AND executionsId = '{{ executionsId }}' -- required
AND view = '{{ view }}';

list

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

SELECT
name,
argument,
callLogLevel,
createTime,
disableConcurrencyQuotaOverflowBuffering,
duration,
endTime,
error,
executionHistoryLevel,
labels,
result,
startTime,
state,
stateError,
status,
workflowRevisionId
FROM google.workflowexecutions.executions
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workflowsId = '{{ workflowsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.

INSERT INTO google.workflowexecutions.executions (
data__argument,
data__callLogLevel,
data__labels,
data__disableConcurrencyQuotaOverflowBuffering,
data__executionHistoryLevel,
projectsId,
locationsId,
workflowsId
)
SELECT 
'{{ argument }}',
'{{ callLogLevel }}',
'{{ labels }}',
{{ disableConcurrencyQuotaOverflowBuffering }},
'{{ executionHistoryLevel }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ workflowsId }}'
RETURNING
name,
argument,
callLogLevel,
createTime,
disableConcurrencyQuotaOverflowBuffering,
duration,
endTime,
error,
executionHistoryLevel,
labels,
result,
startTime,
state,
stateError,
status,
workflowRevisionId
;

Manifest

# Description fields are for documentation purposes
- name: executions
  props:
    - name: projectsId
      value: string
      description: Required parameter for the executions resource.
    - name: locationsId
      value: string
      description: Required parameter for the executions resource.
    - name: workflowsId
      value: string
      description: Required parameter for the executions resource.
    - name: argument
      value: string
      description: >
        Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON string value of `argument`. Example: `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'`
        
    - name: callLogLevel
      value: string
      description: >
        The call logging level associated to this execution.
        
      valid_values: ['CALL_LOG_LEVEL_UNSPECIFIED', 'LOG_ALL_CALLS', 'LOG_ERRORS_ONLY', 'LOG_NONE']
    - name: labels
      value: object
      description: >
        Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution.
        
    - name: disableConcurrencyQuotaOverflowBuffering
      value: boolean
      description: >
        Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available.
        
    - name: executionHistoryLevel
      value: string
      description: >
        Optional. Describes the execution history level to apply to this execution. If not specified, the execution history level is determined by its workflow's execution history level. If the levels are different, the executionHistoryLevel overrides the workflow's execution history level for this execution.
        
      valid_values: ['EXECUTION_HISTORY_LEVEL_UNSPECIFIED', 'EXECUTION_HISTORY_BASIC', 'EXECUTION_HISTORY_DETAILED']

Lifecycle Methods

cancel

Cancels an execution of the given name.

EXEC google.workflowexecutions.executions.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@workflowsId='{{ workflowsId }}' --required, 
@executionsId='{{ executionsId }}' --required;

export_data

Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.

EXEC google.workflowexecutions.executions.export_data 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@workflowsId='{{ workflowsId }}' --required, 
@executionsId='{{ executionsId }}' --required;