Class: OCI::FleetSoftwareUpdate::Models::FsuJob

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_software_update/models/fsu_job.rb

Overview

Exadata Fleet Update Job resource.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_STAGE = 'STAGE'.freeze,
  TYPE_PRECHECK = 'PRECHECK'.freeze,
  TYPE_APPLY = 'APPLY'.freeze,
  TYPE_ROLLBACK_AND_REMOVE_TARGET = 'ROLLBACK_AND_REMOVE_TARGET'.freeze,
  TYPE_CLEANUP = 'CLEANUP'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_UNKNOWN = 'UNKNOWN'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FsuJob

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :type (String) —

    The value to assign to the #type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :fsu_action_id (String) —

    The value to assign to the #fsu_action_id property

  • :progress (OCI::FleetSoftwareUpdate::Models::JobProgressDetails) —

    The value to assign to the #progress property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property

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

    The value to assign to the #system_tags property



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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 200

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.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.fsu_action_id = attributes[:'fsuActionId'] if attributes[:'fsuActionId']

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  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_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  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

#compartment_id ⇒ String

[Required] Compartment Identifier, this will map to the owner Exadata Fleet Update Action resource.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 55

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


106
107
108
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 106

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Exadata Fleet Update Job display name.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 45

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


100
101
102
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 100

def freeform_tags
  @freeform_tags
end

#fsu_action_id ⇒ String

[Required] OCID of the Exadata Fleet Update Action that this job is part of.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 60

def fsu_action_id
  @fsu_action_id
end

#id ⇒ String

[Required] OCID identifier for the Exadata Fleet Update Job.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 40

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 94

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Exadata Fleet Update Job.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 88

def lifecycle_state
  @lifecycle_state
end

#progress ⇒ OCI::FleetSoftwareUpdate::Models::JobProgressDetails

Returns:



63
64
65
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 63

def progress
  @progress
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


112
113
114
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 112

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the Exadata Fleet Update Job was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 68

def time_created
  @time_created
end

#time_finished ⇒ DateTime

The time the Exadata Fleet Update Job completed execution. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 83

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

The time the Exadata Fleet Update Job started execution. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 73

def time_started
  @time_started
end

#time_updated ⇒ DateTime

The time the Exadata Fleet Update Job was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


78
79
80
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 78

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Exadata Fleet Update Job type.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 50

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 115

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'fsu_action_id': :'fsuActionId',
    'progress': :'progress',
    'time_created': :'timeCreated',
    'time_started': :'timeStarted',
    'time_updated': :'timeUpdated',
    'time_finished': :'timeFinished',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 165

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::FleetSoftwareUpdate::Models::ApplyFsuJob' if type == 'APPLY'
  return 'OCI::FleetSoftwareUpdate::Models::StageFsuJob' if type == 'STAGE'
  return 'OCI::FleetSoftwareUpdate::Models::PrecheckFsuJob' if type == 'PRECHECK'
  return 'OCI::FleetSoftwareUpdate::Models::RollbackFsuJob' if type == 'ROLLBACK_AND_REMOVE_TARGET'
  return 'OCI::FleetSoftwareUpdate::Models::CleanupFsuJob' if type == 'CLEANUP'

  # TODO: Log a warning when the subtype is not found.
  'OCI::FleetSoftwareUpdate::Models::FsuJob'
end

.swagger_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 138

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'fsu_action_id': :'String',
    'progress': :'OCI::FleetSoftwareUpdate::Models::JobProgressDetails',
    'time_created': :'DateTime',
    'time_started': :'DateTime',
    'time_updated': :'DateTime',
    'time_finished': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    '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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 318

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    fsu_action_id == other.fsu_action_id &&
    progress == other.progress &&
    time_created == other.time_created &&
    time_started == other.time_started &&
    time_updated == other.time_updated &&
    time_finished == other.time_finished &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 362

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


342
343
344
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 342

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



351
352
353
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 351

def hash
  [id, display_name, type, compartment_id, fsu_action_id, progress, time_created, time_started, time_updated, time_finished, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, 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



395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 395

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



389
390
391
 
# File 'lib/oci/fleet_software_update/models/fsu_job.rb', line 389

def to_s
  to_hash.to_s
end