package google.cloud.workflows.executions.v1beta

Get desktop application:
View/edit binary Protocol Buffers messages

Executions is used to start and manage running instances of [Workflows][google.cloud.workflows.v1beta.Workflow] called executions.

• rpc ListExecutions (ListExecutionsRequest, ListExecutionsResponse)

  executions.proto:44

  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).

  message ListExecutionsRequest

  executions.proto:147

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

  • string parent = 1

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

  • int32 page_size = 2

    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.

  • string page_token = 3

    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.

  • ExecutionView view = 4

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

  message ListExecutionsResponse

  executions.proto:179

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

  • repeated Execution executions = 1

    The executions which match the request.

  • string next_page_token = 2

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

• rpc CreateExecution (CreateExecutionRequest, Execution)

  executions.proto:52

  Creates a new execution using the latest revision of the given workflow.

  message CreateExecutionRequest

  executions.proto:191

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

  • string parent = 1

    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.

  • optional Execution execution = 2

    Required. Execution to be created.

• rpc GetExecution (GetExecutionRequest, Execution)

  executions.proto:61

  Returns an execution of the given name.

  message GetExecutionRequest

  executions.proto:209

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

  • string name = 1

    Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

  • ExecutionView view = 2

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

• rpc CancelExecution (CancelExecutionRequest, Execution)

  executions.proto:69

  Cancels an execution of the given name.

  message CancelExecutionRequest

  executions.proto:228

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

  • string name = 1

    Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

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

Used as response type in: Executions.CancelExecution, Executions.CreateExecution, Executions.GetExecution

Used as field type in: CreateExecutionRequest, ListExecutionsResponse

• string name = 1

  Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

• optional protobuf.Timestamp start_time = 2

  Output only. Marks the beginning of execution.

• optional protobuf.Timestamp end_time = 3

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

• Execution.State state = 4

  Output only. Current state of the execution.

• string argument = 5

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

• string result = 6

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

• optional Execution.Error error = 7

  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`.

• string workflow_revision_id = 8

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

Error describes why the execution was abnormally terminated.

Used in: Execution

• string payload = 1

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

• string context = 2

  Human readable error context, helpful for debugging purposes.

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

Used in: Execution

• 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.

Defines possible views for execution resource.

Used in: GetExecutionRequest, ListExecutionsRequest

• 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.