Class: OCI::Psql::Models::ConfigurationSummary

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

Overview

Summary of the configuration.

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :db_version (String) —

    The value to assign to the #db_version property

  • :shape (String) —

    The value to assign to the #shape property

  • :is_flexible (BOOLEAN) —

    The value to assign to the #is_flexible property

  • :instance_ocpu_count (Integer) —

    The value to assign to the #instance_ocpu_count property

  • :instance_memory_size_in_gbs (Integer) —

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



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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 149

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

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

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

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

  self.is_flexible = attributes[:'isFlexible'] unless attributes[:'isFlexible'].nil?
  self.is_flexible = false if is_flexible.nil? && !attributes.key?(:'isFlexible') # rubocop:disable Style/StringLiterals

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

  self.is_flexible = attributes[:'is_flexible'] unless attributes[:'is_flexible'].nil?
  self.is_flexible = false if is_flexible.nil? && !attributes.key?(:'isFlexible') && !attributes.key?(:'is_flexible') # rubocop:disable Style/StringLiterals

  self.instance_ocpu_count = attributes[:'instanceOcpuCount'] if attributes[:'instanceOcpuCount']

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

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

  self.instance_memory_size_in_gbs = attributes[:'instanceMemorySizeInGBs'] if attributes[:'instanceMemorySizeInGBs']

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

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

  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] The OCID of the compartment that contains the configuration.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 21

def compartment_id
  @compartment_id
end

#db_version ⇒ String

[Required] Version of the PostgreSQL database.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 41

def db_version
  @db_version
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>>) 


77
78
79
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 77

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly display name for the configuration. Avoid entering confidential information.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 17

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


71
72
73
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 71

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the configuration. Immutable on creation.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 13

def id
  @id
end

#instance_memory_size_in_gbs ⇒ Integer

[Required] Memory size in gigabytes with 1GB increment.

It's value is set to 0 if configuration is for a flexible shape.

Returns:

  • (Integer) 


65
66
67
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 65

def instance_memory_size_in_gbs
  @instance_memory_size_in_gbs
end

#instance_ocpu_count ⇒ Integer

[Required] CPU core count.

It's value is set to 0 if configuration is for a flexible shape.

Returns:

  • (Integer) 


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

def instance_ocpu_count
  @instance_ocpu_count
end

#is_flexible ⇒ BOOLEAN

Whether the configuration supports flexible shapes.

Returns:

  • (BOOLEAN) 


51
52
53
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 51

def is_flexible
  @is_flexible
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) 


37
38
39
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 37

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the configuration.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 33

def lifecycle_state
  @lifecycle_state
end

#shape ⇒ String

[Required] The name of the shape for the configuration. Example: VM.Standard.E4.Flex

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 47

def shape
  @shape
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>>) 


83
84
85
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 83

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the configuration was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 29

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'db_version': :'dbVersion',
    'shape': :'shape',
    'is_flexible': :'isFlexible',
    'instance_ocpu_count': :'instanceOcpuCount',
    'instance_memory_size_in_gbs': :'instanceMemorySizeInGBs',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'db_version': :'String',
    'shape': :'String',
    'is_flexible': :'BOOLEAN',
    'instance_ocpu_count': :'Integer',
    'instance_memory_size_in_gbs': :'Integer',
    '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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    db_version == other.db_version &&
    shape == other.shape &&
    is_flexible == other.is_flexible &&
    instance_ocpu_count == other.instance_ocpu_count &&
    instance_memory_size_in_gbs == other.instance_memory_size_in_gbs &&
    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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 284

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


264
265
266
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 264

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



273
274
275
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 273

def hash
  [id, display_name, compartment_id, time_created, lifecycle_state, lifecycle_details, db_version, shape, is_flexible, instance_ocpu_count, instance_memory_size_in_gbs, 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



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 317

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



311
312
313
 
# File 'lib/oci/psql/models/configuration_summary.rb', line 311

def to_s
  to_hash.to_s
end