Class: Google::Apis::WorkflowexecutionsV1::Execution

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/workflowexecutions_v1/classes.rb,
lib/google/apis/workflowexecutions_v1/representations.rb,
lib/google/apis/workflowexecutions_v1/representations.rb

Overview

A running instance of a Workflow.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Execution

Returns a new instance of Execution.



144
145
146
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 144

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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\""' Corresponds to the JSON property argument

Returns:

  • (String) 


80
81
82
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 80

def argument
  @argument
end

#call_log_level ⇒ String

The call logging level associated to this execution. Corresponds to the JSON property callLogLevel

Returns:

  • (String) 


85
86
87
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 85

def call_log_level
  @call_log_level
end

#duration ⇒ String

Output only. Measures the duration of the execution. Corresponds to the JSON property duration

Returns:

  • (String) 


90
91
92
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 90

def duration
  @duration
end

#end_time ⇒ String

Output only. Marks the end of execution, successful or not. Corresponds to the JSON property endTime

Returns:

  • (String) 


95
96
97
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 95

def end_time
  @end_time
end

#error ⇒ Google::Apis::WorkflowexecutionsV1::Error

Error describes why the execution was abnormally terminated. Corresponds to the JSON property error

Returns:



100
101
102
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 100

def error
  @error
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


110
111
112
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 110

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of the execution. Format: projects/project/ locations/location/workflows/workflow/executions/execution Corresponds to the JSON property name

Returns:

  • (String) 


116
117
118
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 116

def name
  @name
end

#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. Corresponds to the JSON property result

Returns:

  • (String) 


122
123
124
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 122

def result
  @result
end

#start_time ⇒ String

Output only. Marks the beginning of execution. Corresponds to the JSON property startTime

Returns:

  • (String) 


127
128
129
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 127

def start_time
  @start_time
end

#state ⇒ String

Output only. Current state of the execution. Corresponds to the JSON property state

Returns:

  • (String) 


132
133
134
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 132

def state
  @state
end

#status ⇒ Google::Apis::WorkflowexecutionsV1::Status

Represents the current status of this execution. Corresponds to the JSON property status

Returns:



137
138
139
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 137

def status
  @status
end

#workflow_revision_id ⇒ String

Output only. Revision of the workflow this execution is using. Corresponds to the JSON property workflowRevisionId

Returns:

  • (String) 


142
143
144
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 142

def workflow_revision_id
  @workflow_revision_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 149

def update!(**args)
  @argument = args[:argument] if args.key?(:argument)
  @call_log_level = args[:call_log_level] if args.key?(:call_log_level)
  @duration = args[:duration] if args.key?(:duration)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @result = args[:result] if args.key?(:result)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @status = args[:status] if args.key?(:status)
  @workflow_revision_id = args[:workflow_revision_id] if args.key?(:workflow_revision_id)
end