Class: OCI::Opsi::Models::OpsiConfiguration

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

Overview

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

OpsiUxConfiguration

Constant Summary collapse

OPSI_CONFIG_TYPE_ENUM = 
[
  OPSI_CONFIG_TYPE_UX_CONFIGURATION = 'UX_CONFIGURATION'.freeze,
  OPSI_CONFIG_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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpsiConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
193
194
195
196
197
198
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
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 163

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

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

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

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

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

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

  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) 


35
36
37
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 35

def compartment_id
  @compartment_id
end

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

Array of configuration item summary objects.

Returns:



85
86
87
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 85

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


59
60
61
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 59

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of OPSI configuration.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 47

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) 


43
44
45
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 43

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

OCID of OPSI configuration resource.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 31

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 81

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

OPSI configuration resource lifecycle state.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 77

def lifecycle_state
  @lifecycle_state
end

#opsi_config_type ⇒ String

[Required] OPSI configuration type.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 39

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


65
66
67
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 65

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time at which the resource was first created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 69

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time at which the resource was last updated. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


73
74
75
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 73

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'opsi_config_type': :'opsiConfigType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    '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.



134
135
136
137
138
139
140
141
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 134

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

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

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

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    '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>>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'config_items': :'Array<OCI::Opsi::Models::OpsiConfigurationConfigurationItemSummary>'
    # 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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 273

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

  self.class == other.class &&
    id == other.id &&
    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 &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 315

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


295
296
297
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 295

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



304
305
306
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 304

def hash
  [id, compartment_id, opsi_config_type, display_name, description, freeform_tags, defined_tags, system_tags, time_created, time_updated, lifecycle_state, lifecycle_details, 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



348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 348

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



342
343
344
 
# File 'lib/oci/opsi/models/opsi_configuration.rb', line 342

def to_s
  to_hash.to_s
end