As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Workflows Executions v1beta API

class google.cloud.workflows.executions_v1beta.types.CancelExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the [CancelExecution][google.cloud.workflows.executions.v1beta.Executions.CancelExecution] method.

name

Required. Name of the execution to be cancelled. Format:

projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Type

str

class google.cloud.workflows.executions_v1beta.types.CreateExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the [CreateExecution][google.cloud.workflows.executions.v1beta.Executions.CreateExecution] method.

parent

Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.

Type

str

execution

Required. Execution to be created.

Type

google.cloud.workflows.executions_v1beta.types.Execution

class google.cloud.workflows.executions_v1beta.types.Execution(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A running instance of a [Workflow][google.cloud.workflows.v1beta.Workflow].

name

Output only. The resource name of the execution. Format:

projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Type

str

start_time

Output only. Marks the beginning of execution.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Marks the end of execution, successful or not.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. Current state of the execution.

Type

google.cloud.workflows.executions_v1beta.types.Execution.State

argument

Input parameters of the execution represented as a JSON string. The size limit is 32KB.

Type

str

result

Output only. Output of the execution represented as a JSON string. The value can only be present if the execution’s state is SUCCEEDED.

Type

str

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.

Type

google.cloud.workflows.executions_v1beta.types.Execution.Error

workflow_revision_id

Output only. Revision of the workflow this execution is using.

Type

str

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

Bases: proto.message.Message

Error describes why the execution was abnormally terminated.

payload

Error payload returned by the execution, represented as a JSON string.

Type

str

context

Human readable error context, helpful for debugging purposes.

Type

str

class State(value)

Bases: proto.enums.Enum

Describes the current state of the execution. More states may 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.

class google.cloud.workflows.executions_v1beta.types.ExecutionView(value)

Bases: proto.enums.Enum

Defines possible views for execution resource.

Values:

EXECUTION_VIEW_UNSPECIFIED (0):

The default / unset value.

BASIC (1):

Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.

FULL (2):

Includes all data.

class google.cloud.workflows.executions_v1beta.types.GetExecutionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the [GetExecution][google.cloud.workflows.executions.v1beta.Executions.GetExecution] method.

name

Required. Name of the execution to be retrieved. Format:

projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

Type

str

view

Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.

Type

google.cloud.workflows.executions_v1beta.types.ExecutionView

class google.cloud.workflows.executions_v1beta.types.ListExecutionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the [ListExecutions][google.cloud.workflows.executions.v1beta.Executions.ListExecutions] method.

parent

Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

Type

str

page_size

Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it’s 10000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.

Type

int

page_token

A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

Type

str

view

Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

Type

google.cloud.workflows.executions_v1beta.types.ExecutionView

class google.cloud.workflows.executions_v1beta.types.ListExecutionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the [ListExecutions][google.cloud.workflows.executions.v1beta.Executions.ListExecutions] method.

executions

The executions which match the request.

Type

MutableSequence[google.cloud.workflows.executions_v1beta.types.Execution]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str