Reference documentation and code samples for the Google Cloud Workflows V1 Client class Execution.
A running instance of a Workflow .
Generated from protobuf message google.cloud.workflows.executions.v1.Execution
Namespace
Google \ Cloud \ Workflows \ Executions \ V1Methods
__construct
Constructor.
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
↳ end_time
↳ duration
↳ 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. 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
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
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.
↳ call_log_level
int
The call logging level associated to this execution.
↳ status
↳ labels
array| Google\Protobuf\Internal\MapField
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
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.
getName
Output only. The resource name of the execution.
Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
string
setName
Output only. The resource name of the execution.
Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
var
string
$this
getStartTime
Output only. Marks the beginning of execution.
hasStartTime
clearStartTime
setStartTime
Output only. Marks the beginning of execution.
$this
getEndTime
Output only. Marks the end of execution, successful or not.
hasEndTime
clearEndTime
setEndTime
Output only. Marks the end of execution, successful or not.
$this
getDuration
Output only. Measures the duration of the execution.
hasDuration
clearDuration
setDuration
Output only. Measures the duration of the execution.
$this
getState
Output only. Current state of the execution.
int
setState
Output only. Current state of the execution.
var
int
$this
getArgument
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\"}"}'
string
setArgument
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\"}"}'
var
string
$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
.
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
.
var
string
$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
.
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
.
$this
getWorkflowRevisionId
Output only. Revision of the workflow this execution is using.
string
setWorkflowRevisionId
Output only. Revision of the workflow this execution is using.
var
string
$this
getCallLogLevel
The call logging level associated to this execution.
int
setCallLogLevel
The call logging level associated to this execution.
var
int
$this
getStatus
Output only. Status tracks the current steps and progress data of this execution.
hasStatus
clearStatus
setStatus
Output only. Status tracks the current steps and progress data of this execution.
$this
getLabels
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.
setLabels
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.
$this
getStateError
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.
hasStateError
clearStateError
setStateError
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.
$this
