Class: OCI::Psql::Models::Configuration

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

Overview

PostgreSQL configuration for a database system.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  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
CONFIG_TYPE_ENUM = 
[
  CONFIG_TYPE_DEFAULT = 'DEFAULT'.freeze,
  CONFIG_TYPE_CUSTOM = 'CUSTOM'.freeze,
  CONFIG_TYPE_COPIED = 'COPIED'.freeze,
  CONFIG_TYPE_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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

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

  • :config_type (String) —

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

  • :compatible_shapes (Array<String>) —

    The value to assign to the #compatible_shapes property

  • :default_config_id (String) —

    The value to assign to the #default_config_id property

  • :configuration_details (OCI::Psql::Models::ConfigurationDetails) —

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



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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/psql/models/configuration.rb', line 202

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

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

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

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

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

  self.is_flexible = attributes[:'isFlexible'] unless attributes[:'isFlexible'].nil?

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

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

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

  self.default_config_id = attributes[:'defaultConfigId'] if attributes[:'defaultConfigId']

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

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

  self.configuration_details = attributes[:'configurationDetails'] if attributes[:'configurationDetails']

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

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

  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) 


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

def compartment_id
  @compartment_id
end

#compatible_shapes ⇒ Array<String>

[Required] Indicates the collection of compatible shapes for this configuration.

Returns:

  • (Array<String>) 


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

def compatible_shapes
  @compatible_shapes
end

#config_type ⇒ String

The type of configuration. Either user-created or a default configuration.

Returns:

  • (String) 


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

def config_type
  @config_type
end

#configuration_details ⇒ OCI::Psql::Models::ConfigurationDetails

This attribute is required.

Returns:



103
104
105
 
# File 'lib/oci/psql/models/configuration.rb', line 103

def configuration_details
  @configuration_details
end

#db_version ⇒ String

[Required] Version of the PostgreSQL database.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/psql/models/configuration.rb', line 61

def db_version
  @db_version
end

#default_config_id ⇒ String

[Required] The Default configuration used for this configuration.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/psql/models/configuration.rb', line 99

def default_config_id
  @default_config_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>>) 


115
116
117
 
# File 'lib/oci/psql/models/configuration.rb', line 115

def defined_tags
  @defined_tags
end

#description ⇒ String

A description for the configuration.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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


109
110
111
 
# File 'lib/oci/psql/models/configuration.rb', line 109

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] A unique identifier for the configuration. Immutable on creation.

Returns:

  • (String) 


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

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) 


90
91
92
 
# File 'lib/oci/psql/models/configuration.rb', line 90

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) 


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

def instance_ocpu_count
  @instance_ocpu_count
end

#is_flexible ⇒ BOOLEAN

Whether the configuration supports flexible shapes.

Returns:

  • (BOOLEAN) 


76
77
78
 
# File 'lib/oci/psql/models/configuration.rb', line 76

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) 


57
58
59
 
# File 'lib/oci/psql/models/configuration.rb', line 57

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the configuration.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/psql/models/configuration.rb', line 53

def lifecycle_state
  @lifecycle_state
end

#shape ⇒ String

[Required] The name of the shape for the configuration.

For multi-shape enabled configurations, it is set to PostgreSQL. Please use compatibleShapes property to get list of supported shapes for such configurations.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/psql/models/configuration.rb', line 72

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


121
122
123
 
# File 'lib/oci/psql/models/configuration.rb', line 121

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/psql/models/configuration.rb', line 49

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/psql/models/configuration.rb', line 124

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

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/psql/models/configuration.rb', line 151

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'db_version': :'String',
    'config_type': :'String',
    'shape': :'String',
    'is_flexible': :'BOOLEAN',
    'instance_ocpu_count': :'Integer',
    'instance_memory_size_in_gbs': :'Integer',
    'compatible_shapes': :'Array<String>',
    'default_config_id': :'String',
    'configuration_details': :'OCI::Psql::Models::ConfigurationDetails',
    '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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/psql/models/configuration.rb', line 344

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    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 &&
    config_type == other.config_type &&
    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 &&
    compatible_shapes == other.compatible_shapes &&
    default_config_id == other.default_config_id &&
    configuration_details == other.configuration_details &&
    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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/oci/psql/models/configuration.rb', line 392

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


372
373
374
 
# File 'lib/oci/psql/models/configuration.rb', line 372

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



381
382
383
 
# File 'lib/oci/psql/models/configuration.rb', line 381

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



425
426
427
428
429
430
431
432
433
434
 
# File 'lib/oci/psql/models/configuration.rb', line 425

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



419
420
421
 
# File 'lib/oci/psql/models/configuration.rb', line 419

def to_s
  to_hash.to_s
end