Class: OCI::Opsi::Models::CreateOpsiConfigurationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/create_opsi_configuration_details.rb

Overview

Information about OPSI configuration to be created. 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

CreateOpsiUxConfigurationDetails

Constant Summary collapse

OPSI_CONFIG_TYPE_ENUM = 
[
  OPSI_CONFIG_TYPE_UX_CONFIGURATION = 'UX_CONFIGURATION'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOpsiConfigurationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 116

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

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

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

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

  self.config_items = attributes[:'configItems'] if attributes[:'configItems']

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

  self.config_items = attributes[:'config_items'] if attributes[:'config_items']
end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 18

def compartment_id
  @compartment_id
end

#config_items ⇒ Array<OCI::Opsi::Models::CreateConfigurationItemDetails>

Array of configuration items with custom values. All and only configuration items requiring custom values should be part of this array.

Returns:



53
54
55
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 53

def config_items
  @config_items
end

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


42
43
44
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 42

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of OPSI configuration.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 30

def description
  @description
end

#display_name ⇒ String

User-friendly display name for the OPSI configuration. The name does not have to be unique.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 26

def display_name
  @display_name
end

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


36
37
38
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 36

def freeform_tags
  @freeform_tags
end

#opsi_config_type ⇒ String

[Required] OPSI configuration type.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 22

def opsi_config_type
  @opsi_config_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>>) 


48
49
50
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 48

def system_tags
  @system_tags
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'opsi_config_type': :'opsiConfigType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'config_items': :'configItems'
    # 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.



92
93
94
95
96
97
98
99
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 92

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

  return 'OCI::Opsi::Models::CreateOpsiUxConfigurationDetails' if type == 'UX_CONFIGURATION'

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

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'opsi_config_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'config_items': :'Array<OCI::Opsi::Models::CreateConfigurationItemDetails>'
    # 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



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 182

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    opsi_config_type == other.opsi_config_type &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    config_items == other.config_items
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 219

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


199
200
201
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 199

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 208

def hash
  [compartment_id, opsi_config_type, display_name, description, freeform_tags, defined_tags, system_tags, config_items].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 252

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



246
247
248
 
# File 'lib/oci/opsi/models/create_opsi_configuration_details.rb', line 246

def to_s
  to_hash.to_s
end