Class: OCI::OsManagementHub::Models::CreateProfileDetails

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

Overview

Provides the information used to create a new 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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateProfileDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

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

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

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 135

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.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.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.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.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']
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 28

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

User-specified description of the registration profile.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 32

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique and you can change the name later. Avoid entering confidential information.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 24

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


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

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


51
52
53
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 51

def is_default_profile
  @is_default_profile
end

#management_station_id ⇒ String

description: The OCID of the management station to associate with an instance once registered. This is required when creating a profile for non-OCI instances.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 38

def management_station_id
  @management_station_id
end

#profile_type ⇒ String

[Required] The type of profile.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 42

def profile_type
  @profile_type
end

#registration_type ⇒ String

The type of instance to register.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 46

def registration_type
  @registration_type
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 68

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'management_station_id': :'managementStationId',
    'profile_type': :'profileType',
    'registration_type': :'registrationType',
    'is_default_profile': :'isDefaultProfile',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # 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.



106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 106

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

  return 'OCI::OsManagementHub::Models::CreateGroupProfileDetails' if type == 'GROUP'
  return 'OCI::OsManagementHub::Models::CreateWindowsStandAloneProfileDetails' if type == 'WINDOWS_STANDALONE'
  return 'OCI::OsManagementHub::Models::CreateStationProfileDetails' if type == 'STATION'
  return 'OCI::OsManagementHub::Models::CreateSoftwareSourceProfileDetails' if type == 'SOFTWARESOURCE'
  return 'OCI::OsManagementHub::Models::CreateLifecycleProfileDetails' if type == 'LIFECYCLE'

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

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'management_station_id': :'String',
    'profile_type': :'String',
    'registration_type': :'String',
    'is_default_profile': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 209

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    management_station_id == other.management_station_id &&
    profile_type == other.profile_type &&
    registration_type == other.registration_type &&
    is_default_profile == other.is_default_profile &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 247

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


227
228
229
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 227

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 236

def hash
  [display_name, compartment_id, description, management_station_id, profile_type, registration_type, is_default_profile, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 280

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



274
275
276
 
# File 'lib/oci/os_management_hub/models/create_profile_details.rb', line 274

def to_s
  to_hash.to_s
end