Class: OCI::OsManagementHub::Models::Profile

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

Overview

Object that defines the registration profile. 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

PROFILE_TYPE_ENUM = 
[
  PROFILE_TYPE_SOFTWARESOURCE = 'SOFTWARESOURCE'.freeze,
  PROFILE_TYPE_GROUP = 'GROUP'.freeze,
  PROFILE_TYPE_LIFECYCLE = 'LIFECYCLE'.freeze,
  PROFILE_TYPE_STATION = 'STATION'.freeze,
  PROFILE_TYPE_WINDOWS_STANDALONE = 'WINDOWS_STANDALONE'.freeze,
  PROFILE_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
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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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
REGISTRATION_TYPE_ENUM = 
[
  REGISTRATION_TYPE_OCI_LINUX = 'OCI_LINUX'.freeze,
  REGISTRATION_TYPE_NON_OCI_LINUX = 'NON_OCI_LINUX'.freeze,
  REGISTRATION_TYPE_OCI_WINDOWS = 'OCI_WINDOWS'.freeze,
  REGISTRATION_TYPE_AUTONOMOUS_LINUX = 'AUTONOMOUS_LINUX'.freeze,
  REGISTRATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Profile

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :management_station_id (String) —

    The value to assign to the #management_station_id property

  • :profile_type (String) —

    The value to assign to the #profile_type property

  • :vendor_name (String) —

    The value to assign to the #vendor_name property

  • :os_family (String) —

    The value to assign to the #os_family property

  • :arch_type (String) —

    The value to assign to the #arch_type property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :registration_type (String) —

    The value to assign to the #registration_type property

  • :is_default_profile (BOOLEAN) —

    The value to assign to the #is_default_profile property

  • :is_service_provided_profile (BOOLEAN) —

    The value to assign to the #is_service_provided_profile 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



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

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

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

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

  self.profile_type = attributes[:'profileType'] if attributes[:'profileType']

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

  self.profile_type = attributes[:'profile_type'] if attributes[:'profile_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.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.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.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.registration_type = attributes[:'registrationType'] if attributes[:'registrationType']

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

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

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

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

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

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

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

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

  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_type ⇒ String

[Required] The architecture type.

Returns:

  • (String) 


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

def arch_type
  @arch_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the registration profile.

Returns:

  • (String) 


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

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

Returns:

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


137
138
139
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 137

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the registration profile.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name for the profile.

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<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>) 


130
131
132
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 130

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the registration profile.

Returns:

  • (String) 


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

def id
  @id
end

#is_default_profile ⇒ BOOLEAN

Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified.

Returns:

  • (BOOLEAN) 


118
119
120
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 118

def is_default_profile
  @is_default_profile
end

#is_service_provided_profile ⇒ BOOLEAN

Indicates if the profile was created by the service. OS Management Hub provides a limited set of standardized profiles that can be used to register Autonomous Linux or Windows instances.

Returns:

  • (BOOLEAN) 


123
124
125
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 123

def is_service_provided_profile
  @is_service_provided_profile
end

#lifecycle_state ⇒ String

The current state of the registration profile.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#management_station_id ⇒ String

The OCID of the management station to associate with an instance once registered. Associating with a management station applies only to non-OCI instances.

Returns:

  • (String) 


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

def management_station_id
  @management_station_id
end

#os_family ⇒ String

[Required] The operating system family.

Returns:

  • (String) 


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

def os_family
  @os_family
end

#profile_type ⇒ String

The type of profile.

Returns:

  • (String) 


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

def profile_type
  @profile_type
end

#registration_type ⇒ String

The type of instance to register.

Returns:

  • (String) 


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

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


143
144
145
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 143

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the registration profile was created (in RFC 3339 format).

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#vendor_name ⇒ String

[Required] The vendor of the operating system for the instance.

Returns:

  • (String) 


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

def vendor_name
  @vendor_name
end

Class Method Details

.attribute_map ⇒ Object

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 146

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'management_station_id': :'managementStationId',
    'profile_type': :'profileType',
    'vendor_name': :'vendorName',
    'os_family': :'osFamily',
    'arch_type': :'archType',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'registration_type': :'registrationType',
    'is_default_profile': :'isDefaultProfile',
    'is_service_provided_profile': :'isServiceProvidedProfile',
    '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.



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 200

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

  return 'OCI::OsManagementHub::Models::WindowsStandaloneProfile' if type == 'WINDOWS_STANDALONE'
  return 'OCI::OsManagementHub::Models::LifecycleProfile' if type == 'LIFECYCLE'
  return 'OCI::OsManagementHub::Models::SoftwareSourceProfile' if type == 'SOFTWARESOURCE'
  return 'OCI::OsManagementHub::Models::GroupProfile' if type == 'GROUP'
  return 'OCI::OsManagementHub::Models::StationProfile' if type == 'STATION'

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

.swagger_types ⇒ Object

Attribute type mapping.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 171

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'management_station_id': :'String',
    'profile_type': :'String',
    'vendor_name': :'String',
    'os_family': :'String',
    'arch_type': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'registration_type': :'String',
    'is_default_profile': :'BOOLEAN',
    'is_service_provided_profile': :'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



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 427

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 &&
    management_station_id == other.management_station_id &&
    profile_type == other.profile_type &&
    vendor_name == other.vendor_name &&
    os_family == other.os_family &&
    arch_type == other.arch_type &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    registration_type == other.registration_type &&
    is_default_profile == other.is_default_profile &&
    is_service_provided_profile == other.is_service_provided_profile &&
    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



473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 473

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


453
454
455
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 453

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



462
463
464
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 462

def hash
  [id, compartment_id, display_name, description, management_station_id, profile_type, vendor_name, os_family, arch_type, time_created, lifecycle_state, registration_type, is_default_profile, is_service_provided_profile, 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



506
507
508
509
510
511
512
513
514
515
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 506

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



500
501
502
 
# File 'lib/oci/os_management_hub/models/profile.rb', line 500

def to_s
  to_hash.to_s
end