Class: OCI::OsManagementHub::Models::ManagedInstanceGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/models/managed_instance_group.rb

Overview

An object that defines the managed instance group.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OS_FAMILY_ENUM =
[
  OS_FAMILY_ORACLE_LINUX_9 = 'ORACLE_LINUX_9'.freeze,
  OS_FAMILY_ORACLE_LINUX_8 = 'ORACLE_LINUX_8'.freeze,
  OS_FAMILY_ORACLE_LINUX_7 = 'ORACLE_LINUX_7'.freeze,
  OS_FAMILY_ORACLE_LINUX_6 = 'ORACLE_LINUX_6'.freeze,
  OS_FAMILY_WINDOWS_SERVER_2016 = 'WINDOWS_SERVER_2016'.freeze,
  OS_FAMILY_WINDOWS_SERVER_2019 = 'WINDOWS_SERVER_2019'.freeze,
  OS_FAMILY_WINDOWS_SERVER_2022 = 'WINDOWS_SERVER_2022'.freeze,
  OS_FAMILY_ALL = 'ALL'.freeze,
  OS_FAMILY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ARCH_TYPE_ENUM =
[
  ARCH_TYPE_X86_64 = 'X86_64'.freeze,
  ARCH_TYPE_AARCH64 = 'AARCH64'.freeze,
  ARCH_TYPE_I686 = 'I686'.freeze,
  ARCH_TYPE_NOARCH = 'NOARCH'.freeze,
  ARCH_TYPE_SRC = 'SRC'.freeze,
  ARCH_TYPE_I386 = 'I386'.freeze,
  ARCH_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VENDOR_NAME_ENUM =
[
  VENDOR_NAME_ORACLE = 'ORACLE'.freeze,
  VENDOR_NAME_MICROSOFT = 'MICROSOFT'.freeze,
  VENDOR_NAME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LOCATION_ENUM =
[
  LOCATION_ON_PREMISE = 'ON_PREMISE'.freeze,
  LOCATION_OCI_COMPUTE = 'OCI_COMPUTE'.freeze,
  LOCATION_AZURE = 'AZURE'.freeze,
  LOCATION_EC2 = 'EC2'.freeze,
  LOCATION_GCP = 'GCP'.freeze,
  LOCATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagedInstanceGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 242

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

  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_modified = attributes[:'timeModified'] if attributes[:'timeModified']

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

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

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

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

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

  self.arch_type = attributes[:'archType'] if attributes[:'archType']

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

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

  self.vendor_name = attributes[:'vendorName'] if attributes[:'vendorName']

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

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

  self.software_source_ids = attributes[:'softwareSourceIds'] if attributes[:'softwareSourceIds']

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

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

  self.software_sources = attributes[:'softwareSources'] if attributes[:'softwareSources']

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

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

  self.managed_instance_ids = attributes[:'managedInstanceIds'] if attributes[:'managedInstanceIds']

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

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

  self.managed_instance_count = attributes[:'managedInstanceCount'] if attributes[:'managedInstanceCount']

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

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

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

  self.pending_job_count = attributes[:'pendingJobCount'] if attributes[:'pendingJobCount']

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

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

  self.notification_topic_id = attributes[:'notificationTopicId'] if attributes[:'notificationTopicId']

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

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

  self.autonomous_settings = attributes[:'autonomousSettings'] if attributes[:'autonomousSettings']

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

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

  self.is_managed_by_autonomous_linux = attributes[:'isManagedByAutonomousLinux'] unless attributes[:'isManagedByAutonomousLinux'].nil?

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

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

  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

#arch_typeString

The CPU architecture of the instances in the managed instance group.

Returns:

  • (String)


93
94
95
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 93

def arch_type
  @arch_type
end

#autonomous_settingsOCI::OsManagementHub::Models::AutonomousSettings



128
129
130
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 128

def autonomous_settings
  @autonomous_settings
end

#compartment_idString

[Required] The OCID of the compartment that contains the managed instance group.

Returns:

  • (String)


65
66
67
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 65

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. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


146
147
148
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 146

def defined_tags
  @defined_tags
end

#descriptionString

User-specified information about the managed instance group.

Returns:

  • (String)


73
74
75
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 73

def description
  @description
end

#display_nameString

A user-friendly name for the managed instance group.

Returns:

  • (String)


69
70
71
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 69

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


139
140
141
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 139

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the managed instance group.

Returns:

  • (String)


61
62
63
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 61

def id
  @id
end

#is_managed_by_autonomous_linuxBOOLEAN

Indicates whether the Autonomous Linux service manages the group.

Returns:

  • (BOOLEAN)


132
133
134
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 132

def is_managed_by_autonomous_linux
  @is_managed_by_autonomous_linux
end

#lifecycle_stateString

[Required] The current state of the managed instance group.

Returns:

  • (String)


85
86
87
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 85

def lifecycle_state
  @lifecycle_state
end

#locationString

The location of managed instances attached to the group.

Returns:

  • (String)


117
118
119
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 117

def location
  @location
end

#managed_instance_countInteger

The number of managed instances in the group.

Returns:

  • (Integer)


113
114
115
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 113

def managed_instance_count
  @managed_instance_count
end

#managed_instance_idsArray<String>

The list of managed instance OCIDs attached to the managed instance group.

Returns:

  • (Array<String>)


109
110
111
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 109

def managed_instance_ids
  @managed_instance_ids
end

#notification_topic_idString

The OCID for the Oracle Notifications service (ONS) topic. ONS is the channel used to send notifications to the customer.

Returns:

  • (String)


125
126
127
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 125

def notification_topic_id
  @notification_topic_id
end

#os_familyString

The operating system type of the instances in the managed instance group.

Returns:

  • (String)


89
90
91
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 89

def os_family
  @os_family
end

#pending_job_countInteger

The number of scheduled jobs pending against the managed instance group.

Returns:

  • (Integer)


121
122
123
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 121

def pending_job_count
  @pending_job_count
end

#software_source_idsArray<OCI::OsManagementHub::Models::SoftwareSourceDetails>

The list of software source OCIDs that the managed instance group will use.



101
102
103
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 101

def software_source_ids
  @software_source_ids
end

#software_sourcesArray<OCI::OsManagementHub::Models::SoftwareSourceDetails>

The list of software sources that the managed instance group will use.



105
106
107
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 105

def software_sources
  @software_sources
end

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


152
153
154
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 152

def system_tags
  @system_tags
end

#time_createdDateTime

The time the managed instance group was created (in RFC 3339 format).

Returns:

  • (DateTime)


77
78
79
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 77

def time_created
  @time_created
end

#time_modifiedDateTime

The time the managed instance group was last modified (in RFC 3339 format).

Returns:

  • (DateTime)


81
82
83
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 81

def time_modified
  @time_modified
end

#vendor_nameString

The vendor of the operating system used by the managed instances in the group.

Returns:

  • (String)


97
98
99
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 97

def vendor_name
  @vendor_name
end

Class Method Details

.attribute_mapObject

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



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
181
182
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 155

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_modified': :'timeModified',
    'lifecycle_state': :'lifecycleState',
    'os_family': :'osFamily',
    'arch_type': :'archType',
    'vendor_name': :'vendorName',
    'software_source_ids': :'softwareSourceIds',
    'software_sources': :'softwareSources',
    'managed_instance_ids': :'managedInstanceIds',
    'managed_instance_count': :'managedInstanceCount',
    'location': :'location',
    'pending_job_count': :'pendingJobCount',
    'notification_topic_id': :'notificationTopicId',
    'autonomous_settings': :'autonomousSettings',
    'is_managed_by_autonomous_linux': :'isManagedByAutonomousLinux',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 185

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'time_created': :'DateTime',
    'time_modified': :'DateTime',
    'lifecycle_state': :'String',
    'os_family': :'String',
    'arch_type': :'String',
    'vendor_name': :'String',
    'software_source_ids': :'Array<OCI::OsManagementHub::Models::SoftwareSourceDetails>',
    'software_sources': :'Array<OCI::OsManagementHub::Models::SoftwareSourceDetails>',
    'managed_instance_ids': :'Array<String>',
    'managed_instance_count': :'Integer',
    'location': :'String',
    'pending_job_count': :'Integer',
    'notification_topic_id': :'String',
    'autonomous_settings': :'OCI::OsManagementHub::Models::AutonomousSettings',
    'is_managed_by_autonomous_linux': :'BOOLEAN',
    '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



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 441

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    time_created == other.time_created &&
    time_modified == other.time_modified &&
    lifecycle_state == other.lifecycle_state &&
    os_family == other.os_family &&
    arch_type == other.arch_type &&
    vendor_name == other.vendor_name &&
    software_source_ids == other.software_source_ids &&
    software_sources == other.software_sources &&
    managed_instance_ids == other.managed_instance_ids &&
    managed_instance_count == other.managed_instance_count &&
    location == other.location &&
    pending_job_count == other.pending_job_count &&
    notification_topic_id == other.notification_topic_id &&
    autonomous_settings == other.autonomous_settings &&
    is_managed_by_autonomous_linux == other.is_managed_by_autonomous_linux &&
    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



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 492

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


472
473
474
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 472

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



481
482
483
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 481

def hash
  [id, compartment_id, display_name, description, time_created, time_modified, lifecycle_state, os_family, arch_type, vendor_name, software_source_ids, software_sources, managed_instance_ids, managed_instance_count, location, pending_job_count, notification_topic_id, autonomous_settings, is_managed_by_autonomous_linux, 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



525
526
527
528
529
530
531
532
533
534
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 525

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



519
520
521
# File 'lib/oci/os_management_hub/models/managed_instance_group.rb', line 519

def to_s
  to_hash.to_s
end