Class: OCI::FleetAppsManagement::Models::Execution

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/execution.rb

Overview

Task Execution associated with the Job.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_WAITING = 'WAITING'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_SKIPPED = 'SKIPPED'.freeze,
  STATUS_IGNORED = 'IGNORED'.freeze,
  STATUS_NOT_APPLICABLE = 'NOT_APPLICABLE'.freeze,
  STATUS_ABORTED = 'ABORTED'.freeze,
  STATUS_TIMED_OUT = 'TIMED_OUT'.freeze,
  STATUS_PAUSED = 'PAUSED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Execution

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :task_record_id (String) —

    The value to assign to the #task_record_id property

  • :step_name (String) —

    The value to assign to the #step_name property

  • :process_reference_id (String) —

    The value to assign to the #process_reference_id property

  • :sequence (String) —

    The value to assign to the #sequence property

  • :subjects (Array<String>) —

    The value to assign to the #subjects property

  • :status (String) —

    The value to assign to the #status property

  • :outcome (OCI::FleetAppsManagement::Models::Outcome) —

    The value to assign to the #outcome property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_ended (DateTime) —

    The value to assign to the #time_ended property

  • :is_rollback_task (BOOLEAN) —

    The value to assign to the #is_rollback_task property

  • :description (String) —

    The value to assign to the #description property

  • :resource_id (String) —

    The value to assign to the #resource_id property

  • :is_retry_exceeded (BOOLEAN) —

    The value to assign to the #is_retry_exceeded property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 167

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.task_record_id = attributes[:'taskRecordId'] if attributes[:'taskRecordId']

  raise 'You cannot provide both :taskRecordId and :task_record_id' if attributes.key?(:'taskRecordId') && attributes.key?(:'task_record_id')

  self.task_record_id = attributes[:'task_record_id'] if attributes[:'task_record_id']

  self.step_name = attributes[:'stepName'] if attributes[:'stepName']

  raise 'You cannot provide both :stepName and :step_name' if attributes.key?(:'stepName') && attributes.key?(:'step_name')

  self.step_name = attributes[:'step_name'] if attributes[:'step_name']

  self.process_reference_id = attributes[:'processReferenceId'] if attributes[:'processReferenceId']

  raise 'You cannot provide both :processReferenceId and :process_reference_id' if attributes.key?(:'processReferenceId') && attributes.key?(:'process_reference_id')

  self.process_reference_id = attributes[:'process_reference_id'] if attributes[:'process_reference_id']

  self.sequence = attributes[:'sequence'] if attributes[:'sequence']

  self.subjects = attributes[:'subjects'] if attributes[:'subjects']

  self.status = attributes[:'status'] if attributes[:'status']

  self.outcome = attributes[:'outcome'] if attributes[:'outcome']

  self.target_id = attributes[:'targetId'] if attributes[:'targetId']

  raise 'You cannot provide both :targetId and :target_id' if attributes.key?(:'targetId') && attributes.key?(:'target_id')

  self.target_id = attributes[:'target_id'] if attributes[:'target_id']

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

  raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started')

  self.time_started = attributes[:'time_started'] if attributes[:'time_started']

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

  raise 'You cannot provide both :timeEnded and :time_ended' if attributes.key?(:'timeEnded') && attributes.key?(:'time_ended')

  self.time_ended = attributes[:'time_ended'] if attributes[:'time_ended']

  self.is_rollback_task = attributes[:'isRollbackTask'] unless attributes[:'isRollbackTask'].nil?

  raise 'You cannot provide both :isRollbackTask and :is_rollback_task' if attributes.key?(:'isRollbackTask') && attributes.key?(:'is_rollback_task')

  self.is_rollback_task = attributes[:'is_rollback_task'] unless attributes[:'is_rollback_task'].nil?

  self.description = attributes[:'description'] if attributes[:'description']

  self.resource_id = attributes[:'resourceId'] if attributes[:'resourceId']

  raise 'You cannot provide both :resourceId and :resource_id' if attributes.key?(:'resourceId') && attributes.key?(:'resource_id')

  self.resource_id = attributes[:'resource_id'] if attributes[:'resource_id']

  self.is_retry_exceeded = attributes[:'isRetryExceeded'] unless attributes[:'isRetryExceeded'].nil?
  self.is_retry_exceeded = false if is_retry_exceeded.nil? && !attributes.key?(:'isRetryExceeded') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isRetryExceeded and :is_retry_exceeded' if attributes.key?(:'isRetryExceeded') && attributes.key?(:'is_retry_exceeded')

  self.is_retry_exceeded = attributes[:'is_retry_exceeded'] unless attributes[:'is_retry_exceeded'].nil?
  self.is_retry_exceeded = false if is_retry_exceeded.nil? && !attributes.key?(:'isRetryExceeded') && !attributes.key?(:'is_retry_exceeded') # rubocop:disable Style/StringLiterals

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#description ⇒ String

Description of the Execution status. If there are any errors, this can also include a short error message.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 81

def description
  @description
end

#id ⇒ String

[Required] Unique Id associated with the task execution.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 30

def id
  @id
end

#is_retry_exceeded ⇒ BOOLEAN

An attribute which tells if further retries are allowed for the task on failure.

Returns:

  • (BOOLEAN) 


89
90
91
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 89

def is_retry_exceeded
  @is_retry_exceeded
end

#is_rollback_task ⇒ BOOLEAN

Is this a rollback task?

Returns:

  • (BOOLEAN) 


75
76
77
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 75

def is_rollback_task
  @is_rollback_task
end

#outcome ⇒ OCI::FleetAppsManagement::Models::Outcome

Returns:



59
60
61
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 59

def outcome
  @outcome
end

#process_reference_id ⇒ String

Unique process-reference identifier returned by the execution client. In some cases, this can be a runcommand OCID.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 44

def process_reference_id
  @process_reference_id
end

#resource_id ⇒ String

Resource Identifier associated with the Work Request.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 85

def resource_id
  @resource_id
end

#sequence ⇒ String

The sequence of the task.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 48

def sequence
  @sequence
end

#status ⇒ String

[Required] Status of the Task

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 56

def status
  @status
end

#step_name ⇒ String

Name of the step.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 38

def step_name
  @step_name
end

#subjects ⇒ Array<String>

Subjects that are tied to the task.

Returns:

  • (Array<String>) 


52
53
54
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 52

def subjects
  @subjects
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


95
96
97
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 95

def system_tags
  @system_tags
end

#target_id ⇒ String

Target associated with the execution.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 63

def target_id
  @target_id
end

#task_record_id ⇒ String

The OCID of taskRecord.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 34

def task_record_id
  @task_record_id
end

#time_ended ⇒ DateTime

The time the task ended. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 71

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

The time the task started. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 67

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'task_record_id': :'taskRecordId',
    'step_name': :'stepName',
    'process_reference_id': :'processReferenceId',
    'sequence': :'sequence',
    'subjects': :'subjects',
    'status': :'status',
    'outcome': :'outcome',
    'target_id': :'targetId',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'is_rollback_task': :'isRollbackTask',
    'description': :'description',
    'resource_id': :'resourceId',
    'is_retry_exceeded': :'isRetryExceeded',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'task_record_id': :'String',
    'step_name': :'String',
    'process_reference_id': :'String',
    'sequence': :'String',
    'subjects': :'Array<String>',
    'status': :'String',
    'outcome': :'OCI::FleetAppsManagement::Models::Outcome',
    'target_id': :'String',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'is_rollback_task': :'BOOLEAN',
    'description': :'String',
    'resource_id': :'String',
    'is_retry_exceeded': :'BOOLEAN',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 268

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    task_record_id == other.task_record_id &&
    step_name == other.step_name &&
    process_reference_id == other.process_reference_id &&
    sequence == other.sequence &&
    subjects == other.subjects &&
    status == other.status &&
    outcome == other.outcome &&
    target_id == other.target_id &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    is_rollback_task == other.is_rollback_task &&
    description == other.description &&
    resource_id == other.resource_id &&
    is_retry_exceeded == other.is_retry_exceeded &&
    system_tags == other.system_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 313

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


293
294
295
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 293

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



302
303
304
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 302

def hash
  [id, task_record_id, step_name, process_reference_id, sequence, subjects, status, outcome, target_id, time_started, time_ended, is_rollback_task, description, resource_id, is_retry_exceeded, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 346

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



340
341
342
 
# File 'lib/oci/fleet_apps_management/models/execution.rb', line 340

def to_s
  to_hash.to_s
end