Class: OCI::OsManagementHub::Models::ProfileSummary

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

Overview

Provides summary information for a registration profile.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProfileSummary

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

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

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

  • :registration_type (String) —

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

  • :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



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

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

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

The architecture type.

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 86

def arch_type
  @arch_type
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 62

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

User-specified description of the registration profile.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 58

def description
  @description
end

#display_name ⇒ String

A user-friendly name for the profile.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 54

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


111
112
113
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 111

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the registration profile.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 50

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) 


99
100
101
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 99

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) 


104
105
106
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 104

def is_service_provided_profile
  @is_service_provided_profile
end

#lifecycle_state ⇒ String

The current state of the registration profile.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 94

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) 


66
67
68
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 66

def management_station_id
  @management_station_id
end

#os_family ⇒ String

The operating system family.

Returns:

  • (String) 


82
83
84
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 82

def os_family
  @os_family
end

#profile_type ⇒ String

The type of registration profile.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 70

def profile_type
  @profile_type
end

#registration_type ⇒ String

The type of instance to register.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 74

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


124
125
126
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 124

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time the the Onboarding was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 90

def time_created
  @time_created
end

#vendor_name ⇒ String

The vendor of the operating system for the instance.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 78

def vendor_name
  @vendor_name
end

Class Method Details

.attribute_map ⇒ Object

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 127

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'management_station_id': :'managementStationId',
    'profile_type': :'profileType',
    'registration_type': :'registrationType',
    'vendor_name': :'vendorName',
    'os_family': :'osFamily',
    'arch_type': :'archType',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'is_default_profile': :'isDefaultProfile',
    'is_service_provided_profile': :'isServiceProvidedProfile',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 152

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



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/os_management_hub/models/profile_summary.rb', line 363

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    management_station_id == other.management_station_id &&
    profile_type == other.profile_type &&
    registration_type == other.registration_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 &&
    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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 409

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


389
390
391
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 389

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



398
399
400
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 398

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



442
443
444
445
446
447
448
449
450
451
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 442

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



436
437
438
 
# File 'lib/oci/os_management_hub/models/profile_summary.rb', line 436

def to_s
  to_hash.to_s
end