Class: OCI::Mysql::Models::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/mysql/models/configuration.rb

Overview

The set of MySQL variables to be used when deploying a MySQL Database Service DB System.

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_DEFAULT = 'DEFAULT'.freeze,
  TYPE_CUSTOM = 'CUSTOM'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ Configuration

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

  • :description (String)

    The value to assign to the #description property

  • :display_name (String)

    The value to assign to the #display_name property

  • :shape_name (String)

    The value to assign to the #shape_name property

  • :type (String)

    The value to assign to the #type property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :time_updated (DateTime)

    The value to assign to the #time_updated property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :variables (OCI::Mysql::Models::ConfigurationVariables)

    The value to assign to the #variables property

  • :parent_configuration_id (String)

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



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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/oci/mysql/models/configuration.rb', line 144

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

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

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

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

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

  self.parent_configuration_id = attributes[:'parentConfigurationId'] if attributes[:'parentConfigurationId']

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

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

  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_idString

[Required] OCID of the Compartment the Configuration exists in.

Returns:

  • (String)


30
31
32
# File 'lib/oci/mysql/models/configuration.rb', line 30

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


81
82
83
# File 'lib/oci/mysql/models/configuration.rb', line 81

def defined_tags
  @defined_tags
end

#descriptionString

User-provided data about the Configuration.

Returns:

  • (String)


34
35
36
# File 'lib/oci/mysql/models/configuration.rb', line 34

def description
  @description
end

#display_nameString

The display name of the Configuration.

Returns:

  • (String)


38
39
40
# File 'lib/oci/mysql/models/configuration.rb', line 38

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Simple key-value pair applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>)


75
76
77
# File 'lib/oci/mysql/models/configuration.rb', line 75

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the Configuration.

Returns:

  • (String)


26
27
28
# File 'lib/oci/mysql/models/configuration.rb', line 26

def id
  @id
end

#lifecycle_stateString

[Required] The current state of the Configuration.

Returns:

  • (String)


58
59
60
# File 'lib/oci/mysql/models/configuration.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#parent_configuration_idString

The OCID of the Configuration from which this Configuration is "derived". This is entirely a metadata relationship. There is no relation between the values in this Configuration and its parent.

Returns:

  • (String)


69
70
71
# File 'lib/oci/mysql/models/configuration.rb', line 69

def parent_configuration_id
  @parent_configuration_id
end

#shape_nameString

[Required] The name of the associated Shape.

Returns:

  • (String)


42
43
44
# File 'lib/oci/mysql/models/configuration.rb', line 42

def shape_name
  @shape_name
end

#time_createdDateTime

[Required] The date and time the Configuration was created, as described by RFC 3339.

Returns:

  • (DateTime)


50
51
52
# File 'lib/oci/mysql/models/configuration.rb', line 50

def time_created
  @time_created
end

#time_updatedDateTime

[Required] The date and time the Configuration was last updated, as described by RFC 3339.

Returns:

  • (DateTime)


54
55
56
# File 'lib/oci/mysql/models/configuration.rb', line 54

def time_updated
  @time_updated
end

#typeString

[Required] The Configuration type, DEFAULT or CUSTOM.

Returns:

  • (String)


46
47
48
# File 'lib/oci/mysql/models/configuration.rb', line 46

def type
  @type
end

#variablesOCI::Mysql::Models::ConfigurationVariables

This attribute is required.



62
63
64
# File 'lib/oci/mysql/models/configuration.rb', line 62

def variables
  @variables
end

Class Method Details

.attribute_mapObject

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/oci/mysql/models/configuration.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'display_name': :'displayName',
    'shape_name': :'shapeName',
    'type': :'type',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'variables': :'variables',
    'parent_configuration_id': :'parentConfigurationId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/oci/mysql/models/configuration.rb', line 105

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'display_name': :'String',
    'shape_name': :'String',
    'type': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'variables': :'OCI::Mysql::Models::ConfigurationVariables',
    'parent_configuration_id': :'String',
    '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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/oci/mysql/models/configuration.rb', line 246

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    display_name == other.display_name &&
    shape_name == other.shape_name &&
    type == other.type &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    variables == other.variables &&
    parent_configuration_id == other.parent_configuration_id &&
    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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/oci/mysql/models/configuration.rb', line 288

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


268
269
270
# File 'lib/oci/mysql/models/configuration.rb', line 268

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



277
278
279
# File 'lib/oci/mysql/models/configuration.rb', line 277

def hash
  [id, compartment_id, description, display_name, shape_name, type, time_created, time_updated, lifecycle_state, variables, parent_configuration_id, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



321
322
323
324
325
326
327
328
329
330
# File 'lib/oci/mysql/models/configuration.rb', line 321

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



315
316
317
# File 'lib/oci/mysql/models/configuration.rb', line 315

def to_s
  to_hash.to_s
end