Workflows Executions V1 API - Class Google::Cloud::Workflows::Executions::V1::Execution (v0.2.0)

Version 0.2.0

• 1.0.1 (latest)
• 1.0.0
• 0.7.0
• 0.6.2
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.2

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.

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

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

#workflow_revision_id

def workflow_revision_id() -> ::String

Returns

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