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.



260
261
262
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 260

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) 


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

def argument
  @argument
end

#call_log_level ⇒ String

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

Returns:

  • (String) 


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

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) 


178
179
180
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 178

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) 


185
186
187
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 185

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) 


191
192
193
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 191

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) 


196
197
198
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 196

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:



201
202
203
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 201

def error
  @error
end

#execution_history_level ⇒ String

Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. Corresponds to the JSON property executionHistoryLevel

Returns:

  • (String) 


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

def execution_history_level
  @execution_history_level
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>) 


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

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) 


226
227
228
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 226

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) 


232
233
234
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 232

def result
  @result
end

#start_time ⇒ String

Output only. Marks the beginning of execution. Note that this will be the same as createTime for executions that start immediately. Corresponds to the JSON property startTime

Returns:

  • (String) 


238
239
240
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 238

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


243
244
245
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 243

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:



248
249
250
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 248

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:



253
254
255
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 253

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) 


258
259
260
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 258

def workflow_revision_id
  @workflow_revision_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 265

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)
  @execution_history_level = args[:execution_history_level] if args.key?(:execution_history_level)
  @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