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



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
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/mysql/models/configuration.rb', line 167

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

  self.init_variables = attributes[:'initVariables'] if attributes[:'initVariables']

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

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

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

  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

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


89
90
91
 
# File 'lib/oci/mysql/models/configuration.rb', line 89

def defined_tags
  @defined_tags
end

#description ⇒ String

User-provided data about the Configuration.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

The display name of the Configuration.

Returns:

  • (String) 


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

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


83
84
85
 
# File 'lib/oci/mysql/models/configuration.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Configuration.

Returns:

  • (String) 


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

def id
  @id
end

#init_variables ⇒ OCI::Mysql::Models::InitializationVariables

Returns:



66
67
68
 
# File 'lib/oci/mysql/models/configuration.rb', line 66

def init_variables
  @init_variables
end

#lifecycle_state ⇒ String

[Required] The current state of the Configuration.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#options ⇒ Array<OCI::Mysql::Models::Option>

[Required] The MySQL options defined in the Configuration.

Returns:



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

def options
  @options
end

#parent_configuration_id ⇒ String

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) 


77
78
79
 
# File 'lib/oci/mysql/models/configuration.rb', line 77

def parent_configuration_id
  @parent_configuration_id
end

#shape_name ⇒ String

[Required] The name of the associated Shape.

Returns:

  • (String) 


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

def shape_name
  @shape_name
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


95
96
97
 
# File 'lib/oci/mysql/models/configuration.rb', line 95

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The Configuration type, DEFAULT or CUSTOM.

Returns:

  • (String) 


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

def type
  @type
end

#variables ⇒ OCI::Mysql::Models::ConfigurationVariables

This attribute is required.

Returns:



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

def variables
  @variables
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/mysql/models/configuration.rb', line 98

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',
    'options': :'options',
    'init_variables': :'initVariables',
    'variables': :'variables',
    'parent_configuration_id': :'parentConfigurationId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/mysql/models/configuration.rb', line 122

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',
    'options': :'Array<OCI::Mysql::Models::Option>',
    'init_variables': :'OCI::Mysql::Models::InitializationVariables',
    'variables': :'OCI::Mysql::Models::ConfigurationVariables',
    'parent_configuration_id': :'String',
    '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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/mysql/models/configuration.rb', line 283

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 &&
    options == other.options &&
    init_variables == other.init_variables &&
    variables == other.variables &&
    parent_configuration_id == other.parent_configuration_id &&
    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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/oci/mysql/models/configuration.rb', line 328

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


308
309
310
 
# File 'lib/oci/mysql/models/configuration.rb', line 308

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



317
318
319
 
# File 'lib/oci/mysql/models/configuration.rb', line 317

def hash
  [id, compartment_id, description, display_name, shape_name, type, time_created, time_updated, lifecycle_state, options, init_variables, variables, parent_configuration_id, 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



361
362
363
364
365
366
367
368
369
370
 
# File 'lib/oci/mysql/models/configuration.rb', line 361

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



355
356
357
 
# File 'lib/oci/mysql/models/configuration.rb', line 355

def to_s
  to_hash.to_s
end