Class: OCI::FleetSoftwareUpdate::Models::FsuCycle

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

Overview

Exadata Fleet Update Cycle resource details.

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

Direct Known Subclasses

PatchFsuCycle

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_PATCH = 'PATCH'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
COLLECTION_TYPE_ENUM =
[
  COLLECTION_TYPE_DB = 'DB'.freeze,
  COLLECTION_TYPE_GI = 'GI'.freeze,
  COLLECTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LAST_COMPLETED_ACTION_ENUM =
[
  LAST_COMPLETED_ACTION_STAGE = 'STAGE'.freeze,
  LAST_COMPLETED_ACTION_PRECHECK_STAGE = 'PRECHECK_STAGE'.freeze,
  LAST_COMPLETED_ACTION_PRECHECK_APPLY = 'PRECHECK_APPLY'.freeze,
  LAST_COMPLETED_ACTION_APPLY = 'APPLY'.freeze,
  LAST_COMPLETED_ACTION_ROLLBACK_AND_REMOVE_TARGET = 'ROLLBACK_AND_REMOVE_TARGET'.freeze,
  LAST_COMPLETED_ACTION_CLEANUP = 'CLEANUP'.freeze,
  LAST_COMPLETED_ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ FsuCycle

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 253

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

  self.fsu_collection_id = attributes[:'fsuCollectionId'] if attributes[:'fsuCollectionId']

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

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

  self.collection_type = attributes[:'collectionType'] if attributes[:'collectionType']

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

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

  self.executing_fsu_action_id = attributes[:'executingFsuActionId'] if attributes[:'executingFsuActionId']

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

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

  self.next_action_to_execute = attributes[:'nextActionToExecute'] if attributes[:'nextActionToExecute']

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

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

  self.last_completed_action = attributes[:'lastCompletedAction'] if attributes[:'lastCompletedAction']

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

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

  self.goal_version_details = attributes[:'goalVersionDetails'] if attributes[:'goalVersionDetails']

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

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

  self.batching_strategy = attributes[:'batchingStrategy'] if attributes[:'batchingStrategy']

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

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

  self.stage_action_schedule = attributes[:'stageActionSchedule'] if attributes[:'stageActionSchedule']

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

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

  self.apply_action_schedule = attributes[:'applyActionSchedule'] if attributes[:'applyActionSchedule']

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

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

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

#apply_action_scheduleOCI::FleetSoftwareUpdate::Models::ScheduleDetails



104
105
106
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 104

def apply_action_schedule
  @apply_action_schedule
end

#batching_strategyOCI::FleetSoftwareUpdate::Models::BatchingStrategyDetails



98
99
100
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 98

def batching_strategy
  @batching_strategy
end

#collection_typeString

Type of Collection this Exadata Fleet Update Cycle belongs to.

Returns:

  • (String)


76
77
78
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 76

def collection_type
  @collection_type
end

#compartment_idString

[Required] Compartment Identifier.

Returns:

  • (String)


61
62
63
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 61

def compartment_id
  @compartment_id
end

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


145
146
147
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 145

def defined_tags
  @defined_tags
end

#display_nameString

Exadata Fleet Update Cycle display name.

Returns:

  • (String)


56
57
58
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 56

def display_name
  @display_name
end

#executing_fsu_action_idString

OCID identifier for the Action that is currently in execution, if applicable.

Returns:

  • (String)


81
82
83
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 81

def executing_fsu_action_id
  @executing_fsu_action_id
end

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


139
140
141
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 139

def freeform_tags
  @freeform_tags
end

#fsu_collection_idString

[Required] OCID identifier for the Collection ID the Exadata Fleet Update Cycle is assigned to.

Returns:

  • (String)


71
72
73
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 71

def fsu_collection_id
  @fsu_collection_id
end

#goal_version_detailsOCI::FleetSoftwareUpdate::Models::FsuGoalVersionDetails



95
96
97
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 95

def goal_version_details
  @goal_version_details
end

#idString

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

Returns:

  • (String)


51
52
53
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 51

def id
  @id
end

#last_completed_actionString

The latest Action type that was completed in the Exadata Fleet Update Cycle. No value would indicate that the Cycle has not completed any Action yet.

Returns:

  • (String)


92
93
94
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 92

def last_completed_action
  @last_completed_action
end

#lifecycle_detailsString

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)


133
134
135
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 133

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

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

Returns:

  • (String)


127
128
129
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 127

def lifecycle_state
  @lifecycle_state
end

#next_action_to_executeArray<OCI::FleetSoftwareUpdate::Models::NextActionToExecuteDetails>

In this array all the possible actions will be listed. The first element is the suggested Action.



86
87
88
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 86

def next_action_to_execute
  @next_action_to_execute
end

#stage_action_scheduleOCI::FleetSoftwareUpdate::Models::ScheduleDetails



101
102
103
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 101

def stage_action_schedule
  @stage_action_schedule
end

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


151
152
153
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 151

def system_tags
  @system_tags
end

#time_createdDateTime

[Required] The date and time the Exadata Fleet Update Cycle was created, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime)


110
111
112
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 110

def time_created
  @time_created
end

#time_finishedDateTime

The date and time the Exadata Fleet Update Cycle was finished, as described in RFC 3339.

Returns:

  • (DateTime)


123
124
125
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 123

def time_finished
  @time_finished
end

#time_updatedDateTime

The date and time the Exadata Fleet Update Cycle was updated, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime)


117
118
119
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 117

def time_updated
  @time_updated
end

#typeString

[Required] Type of Exadata Fleet Update Cycle.

Returns:

  • (String)


66
67
68
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 66

def type
  @type
end

Class Method Details

.attribute_mapObject

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 154

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'fsu_collection_id': :'fsuCollectionId',
    'collection_type': :'collectionType',
    'executing_fsu_action_id': :'executingFsuActionId',
    'next_action_to_execute': :'nextActionToExecute',
    'last_completed_action': :'lastCompletedAction',
    'goal_version_details': :'goalVersionDetails',
    'batching_strategy': :'batchingStrategy',
    'stage_action_schedule': :'stageActionSchedule',
    'apply_action_schedule': :'applyActionSchedule',
    'time_created': :'timeCreated',
    '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.



216
217
218
219
220
221
222
223
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 216

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

  return 'OCI::FleetSoftwareUpdate::Models::PatchFsuCycle' if type == 'PATCH'

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

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 183

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'type': :'String',
    'fsu_collection_id': :'String',
    'collection_type': :'String',
    'executing_fsu_action_id': :'String',
    'next_action_to_execute': :'Array<OCI::FleetSoftwareUpdate::Models::NextActionToExecuteDetails>',
    'last_completed_action': :'String',
    'goal_version_details': :'OCI::FleetSoftwareUpdate::Models::FsuGoalVersionDetails',
    'batching_strategy': :'OCI::FleetSoftwareUpdate::Models::BatchingStrategyDetails',
    'stage_action_schedule': :'OCI::FleetSoftwareUpdate::Models::ScheduleDetails',
    'apply_action_schedule': :'OCI::FleetSoftwareUpdate::Models::ScheduleDetails',
    'time_created': :'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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 437

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    fsu_collection_id == other.fsu_collection_id &&
    collection_type == other.collection_type &&
    executing_fsu_action_id == other.executing_fsu_action_id &&
    next_action_to_execute == other.next_action_to_execute &&
    last_completed_action == other.last_completed_action &&
    goal_version_details == other.goal_version_details &&
    batching_strategy == other.batching_strategy &&
    stage_action_schedule == other.stage_action_schedule &&
    apply_action_schedule == other.apply_action_schedule &&
    time_created == other.time_created &&
    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



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 487

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


467
468
469
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 467

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



476
477
478
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 476

def hash
  [id, display_name, compartment_id, type, fsu_collection_id, collection_type, executing_fsu_action_id, next_action_to_execute, last_completed_action, goal_version_details, batching_strategy, stage_action_schedule, apply_action_schedule, time_created, time_updated, time_finished, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



520
521
522
523
524
525
526
527
528
529
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 520

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



514
515
516
# File 'lib/oci/fleet_software_update/models/fsu_cycle.rb', line 514

def to_s
  to_hash.to_s
end