executions

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

Overview

Name	executions
Type	Resource
Id	google.workflowexecutions.executions

Fields

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	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	Output only. Measures the duration of the execution.
endTime	string	Output only. Marks the end of execution, successful or not.
error	object	Error describes why the execution was abnormally terminated.
executionHistoryLevel	string	Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction.
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	Output only. Marks the beginning of execution.
state	string	Output only. Current state of the execution.
stateError	object	Describes an error related to the current state of the Execution resource.
status	object	Represents the current status of this execution.
workflowRevisionId	string	Output only. Revision of the workflow this execution is using.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	executionsId, locationsId, projectsId, workflowsId	Returns an execution of the given name.
list	SELECT	locationsId, projectsId, workflowsId	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	locationsId, projectsId, workflowsId	Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.
cancel	EXEC	executionsId, locationsId, projectsId, workflowsId	Cancels an execution of the given name.
export_data	EXEC	executionsId, locationsId, projectsId, workflowsId	Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.

SELECT examples

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 locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND workflowsId = '{{ workflowsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new executions resource.

All Properties

/*+ create */
INSERT INTO google.workflowexecutions.executions (
locationsId,
projectsId,
workflowsId,
argument,
callLogLevel,
labels,
disableConcurrencyQuotaOverflowBuffering,
executionHistoryLevel
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ workflowsId }}',
'{{ argument }}',
'{{ callLogLevel }}',
'{{ labels }}',
{{ disableConcurrencyQuotaOverflowBuffering }},
'{{ executionHistoryLevel }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: createTime
      value: string
    - name: startTime
      value: string
    - name: endTime
      value: string
    - name: duration
      value: string
    - name: state
      value: string
    - name: argument
      value: string
    - name: result
      value: string
    - name: error
      value:
        - name: payload
          value: string
        - name: context
          value: string
        - name: stackTrace
          value:
            - name: elements
              value:
                - - name: step
                    value: string
                  - name: routine
                    value: string
                  - name: position
                    value:
                      - name: line
                        value: string
                      - name: column
                        value: string
                      - name: length
                        value: string
    - name: workflowRevisionId
      value: string
    - name: callLogLevel
      value: string
    - name: status
      value:
        - name: currentSteps
          value:
            - - name: routine
                value: string
              - name: step
                value: string
    - name: labels
      value: object
    - name: stateError
      value:
        - name: details
          value: string
        - name: type
          value: string
    - name: disableConcurrencyQuotaOverflowBuffering
      value: boolean
    - name: executionHistoryLevel
      value: string