Workflows Executions V1 API - Class Google::Cloud::Workflows::Executions::V1::Execution (v1.1.0)

Reference documentation and code samples for the Workflows Executions V1 API class Google::Cloud::Workflows::Executions::V1::Execution.

A running instance of a Workflow.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#argument

def argument() -> ::String

Returns

(::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\"}"}'

#argument=

def argument=(value) -> ::String

Parameter

value (::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\"}"}'

Returns

(::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\"}"}'

#call_log_level

def call_log_level() -> ::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel

Returns

(::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel) — The call logging level associated to this execution.

#call_log_level=

def call_log_level=(value) -> ::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel

Parameter

value (::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel) — The call logging level associated to this execution.

Returns

(::Google::Cloud::Workflows::Executions::V1::Execution::CallLogLevel) — The call logging level associated to this execution.

#duration

def duration() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — Output only. Measures the duration of the execution.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Marks the end of execution, successful or not.

#error

def error() -> ::Google::Cloud::Workflows::Executions::V1::Execution::Error

Returns

(::Google::Cloud::Workflows::Executions::V1::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String

Returns

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

#result

def result() -> ::String

Returns

(::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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Marks the beginning of execution.

#state

def state() -> ::Google::Cloud::Workflows::Executions::V1::Execution::State

Returns

(::Google::Cloud::Workflows::Executions::V1::Execution::State) — Output only. Current state of the execution.

#state_error

def state_error() -> ::Google::Cloud::Workflows::Executions::V1::Execution::StateError

Returns

(::Google::Cloud::Workflows::Executions::V1::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.

#status

def status() -> ::Google::Cloud::Workflows::Executions::V1::Execution::Status

Returns

(::Google::Cloud::Workflows::Executions::V1::Execution::Status) — Output only. Status tracks the current steps and progress data of this execution.

#workflow_revision_id

def workflow_revision_id() -> ::String

Returns

(::String) — Output only. Revision of the workflow this execution is using.