Class: OCI::Mysql::Models::ConfigurationSummary

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

Overview

The general details of a Configuration such as its id, displayName, type, and shape association.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConfigurationSummary

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

  • :lifecycle_state (String) —

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

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

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 124

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


18
19
20
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 18

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

User-provided data about the Configuration.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 22

def description
  @description
end

#display_name ⇒ String

The display name of the Configuration.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/mysql/models/configuration_summary.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>) 


52
53
54
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 52

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Configuration.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 14

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the Configuration.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#shape_name ⇒ String

[Required] The name of the associated Shape.

Returns:

  • (String) 


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

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


64
65
66
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 64

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The Configuration type, DEFAULT or CUSTOM

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 67

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 198

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 &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 239

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


219
220
221
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 219

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 228

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



272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 272

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



266
267
268
 
# File 'lib/oci/mysql/models/configuration_summary.rb', line 266

def to_s
  to_hash.to_s
end