Google Cloud Workflows V1beta Client - Class Execution (0.5.5)

Reference documentation and code samples for the Google Cloud Workflows V1beta Client class Execution.

A running instance of a Workflow.

Generated from protobuf message google.cloud.workflows.executions.v1beta.Execution

Namespace

Google \ Cloud \ Workflows \ Executions \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
`↳ start_time`	`Google\Protobuf\Timestamp` Output only. Marks the beginning of execution.
`↳ end_time`	`Google\Protobuf\Timestamp` Output only. Marks the end of execution, successful or not.
`↳ state`	`int` Output only. Current state of the execution.
`↳ argument`	`string` Input parameters of the execution represented as a JSON string. The size limit is 32KB.
`↳ 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`.
`↳ error`	`Google\Cloud\Workflows\Executions\V1beta\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`	`string` Output only. Revision of the workflow this execution is using.

getName

Output only. The resource name of the execution.

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

Returns
Type	Description
`string`

setName

Output only. The resource name of the execution.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartTime

Output only. Marks the beginning of execution.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasStartTime

clearStartTime

setStartTime

Output only. Marks the beginning of execution.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getEndTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasEndTime

clearEndTime

setEndTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. Current state of the execution.

Returns
Type	Description
`int`

setState

Output only. Current state of the execution.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getArgument

Input parameters of the execution represented as a JSON string.

The size limit is 32KB.

Returns
Type	Description
`string`

setArgument

Input parameters of the execution represented as a JSON string.

The size limit is 32KB.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getResult

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

Returns
Type	Description
`string`

setResult

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getError

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.

Returns
Type	Description
`Google\Cloud\Workflows\Executions\V1beta\Execution\Error\|null`

hasError

clearError

setError

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.

Parameter
Name	Description
`var`	`Google\Cloud\Workflows\Executions\V1beta\Execution\Error`

Returns
Type	Description
`$this`

getWorkflowRevisionId

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

Returns
Type	Description
`string`

setWorkflowRevisionId

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`