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.



221
222
223
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 221

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) 


139
140
141
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 139

def argument
  @argument
end

#call_log_level ⇒ String

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

Returns:

  • (String) 


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

def call_log_level
  @call_log_level
end

#create_time ⇒ String

Output only. Marks the creation of the execution. Corresponds to the JSON property createTime

Returns:

  • (String) 


149
150
151
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 149

def create_time
  @create_time
end

#disable_concurrency_quota_overflow_buffering ⇒ Boolean Also known as: disable_concurrency_quota_overflow_buffering?

Optional. If set to true, the execution will not be backlogged when the concurrency quota is exhausted. The backlog execution starts when the concurrency quota becomes available. Corresponds to the JSON property disableConcurrencyQuotaOverflowBuffering

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 156

def disable_concurrency_quota_overflow_buffering
  @disable_concurrency_quota_overflow_buffering
end

#duration ⇒ String

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

Returns:

  • (String) 


162
163
164
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 162

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) 


167
168
169
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 167

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:



172
173
174
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 172

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>) 


182
183
184
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 182

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) 


188
189
190
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 188

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) 


194
195
196
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 194

def result
  @result
end

#start_time ⇒ String

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

Returns:

  • (String) 


199
200
201
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 199

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


204
205
206
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 204

def state
  @state
end

#state_error ⇒ Google::Apis::WorkflowexecutionsV1::StateError

Describes an error related to the current state of the Execution resource. Corresponds to the JSON property stateError

Returns:



209
210
211
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 209

def state_error
  @state_error
end

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

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

Returns:



214
215
216
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 214

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) 


219
220
221
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 219

def workflow_revision_id
  @workflow_revision_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 226

def update!(**args)
  @argument = args[:argument] if args.key?(:argument)
  @call_log_level = args[:call_log_level] if args.key?(:call_log_level)
  @create_time = args[:create_time] if args.key?(:create_time)
  @disable_concurrency_quota_overflow_buffering = args[:disable_concurrency_quota_overflow_buffering] if args.key?(:disable_concurrency_quota_overflow_buffering)
  @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)
  @state_error = args[:state_error] if args.key?(:state_error)
  @status = args[:status] if args.key?(:status)
  @workflow_revision_id = args[:workflow_revision_id] if args.key?(:workflow_revision_id)
end