Class Execution (1.14.2)

Execution(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A running instance of a Workflow </workflows/docs/reference/rest/v1/projects.locations.workflows>__.

Attributes

NameDescription
name str
Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
start_time google.protobuf.timestamp_pb2.Timestamp
Output only. Marks the beginning of execution.
end_time google.protobuf.timestamp_pb2.Timestamp
Output only. Marks the end of execution, successful or not.
duration google.protobuf.duration_pb2.Duration
Output only. Measures the duration of the execution.
state google.cloud.workflows.executions_v1.types.Execution.State
Output only. Current state of the execution.
argument str
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\"}"}'
result str
Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.
error google.cloud.workflows.executions_v1.types.Execution.Error
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.
workflow_revision_id str
Output only. Revision of the workflow this execution is using.
call_log_level google.cloud.workflows.executions_v1.types.Execution.CallLogLevel
The call logging level associated to this execution.
status google.cloud.workflows.executions_v1.types.Execution.Status
Output only. Status tracks the current steps and progress data of this execution.
labels MutableMapping[str, str]
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.
state_error google.cloud.workflows.executions_v1.types.Execution.StateError
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.

Classes

CallLogLevel

CallLogLevel(value)

Describes the level of platform logging to apply to calls and call responses during workflow executions.

Values: CALL_LOG_LEVEL_UNSPECIFIED (0): No call logging level specified. LOG_ALL_CALLS (1): Log all call steps within workflows, all call returns, and all exceptions raised. LOG_ERRORS_ONLY (2): Log only exceptions that are raised from call steps within workflows. LOG_NONE (3): Explicitly log nothing.

Error

Error(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Error describes why the execution was abnormally terminated.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

StackTrace

StackTrace(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A collection of stack elements (frames) where an error occurred.

StackTraceElement

StackTraceElement(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A single stack element (frame) where an error occurred.

State

State(value)

Describes the current state of the execution. More states might be added in the future.

Values: STATE_UNSPECIFIED (0): Invalid state. ACTIVE (1): The execution is in progress. SUCCEEDED (2): The execution finished successfully. FAILED (3): The execution failed with an error. CANCELLED (4): The execution was stopped intentionally. UNAVAILABLE (5): Execution data is unavailable. See the state_error field. QUEUED (6): Request has been placed in the backlog for processing at a later time.

StateError

StateError(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Describes an error related to the current state of the Execution resource.

Status

Status(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the current status of this execution.