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.



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

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

#duration ⇒ String

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

Returns:

  • (String) 


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

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) 


154
155
156
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 154

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:



159
160
161
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 159

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


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

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) 


175
176
177
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 175

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) 


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

def result
  @result
end

#start_time ⇒ String

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

Returns:

  • (String) 


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

def start_time
  @start_time
end

#state ⇒ String

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

Returns:

  • (String) 


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

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:



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

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:



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

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) 


206
207
208
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 206

def workflow_revision_id
  @workflow_revision_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/google/apis/workflowexecutions_v1/classes.rb', line 213

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