Class: LinodeOpenapiClient::PostDatabasesPostgreSqlInstances200Response

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb

Overview

Managed PostgreSQL Databases object.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostDatabasesPostgreSqlInstances200Response

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
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
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 164

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinodeOpenapiClient::PostDatabasesPostgreSqlInstances200Response` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `LinodeOpenapiClient::PostDatabasesPostgreSqlInstances200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.key?(:'encrypted')
    self.encrypted = attributes[:'encrypted']
  else
    self.encrypted = false
  end

  if attributes.key?(:'replication_type')
    self.replication_type = attributes[:'replication_type']
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end

  if attributes.key?(:'updated')
    self.updated = attributes[:'updated']
  end

  if attributes.key?(:'ssl_connection')
    self.ssl_connection = attributes[:'ssl_connection']
  else
    self.ssl_connection = true
  end

  if attributes.key?(:'port')
    self.port = attributes[:'port']
  end

  if attributes.key?(:'updates')
    self.updates = attributes[:'updates']
  end

  if attributes.key?(:'replication_commit_type')
    self.replication_commit_type = attributes[:'replication_commit_type']
  else
    self.replication_commit_type = 'local'
  end

  if attributes.key?(:'engine')
    self.engine = attributes[:'engine']
  end

  if attributes.key?(:'allow_list')
    if (value = attributes[:'allow_list']).is_a?(Array)
      self.allow_list = value
    end
  end

  if attributes.key?(:'cluster_size')
    self.cluster_size = attributes[:'cluster_size']
  else
    self.cluster_size = CLUSTER_SIZE::N1
  end

  if attributes.key?(:'total_disk_size_gb')
    self.total_disk_size_gb = attributes[:'total_disk_size_gb']
  end

  if attributes.key?(:'hosts')
    self.hosts = attributes[:'hosts']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'used_disk_size_gb')
    self.used_disk_size_gb = attributes[:'used_disk_size_gb']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'region')
    self.region = attributes[:'region']
  end
end

Instance Attribute Details

#allow_list ⇒ Object

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format. By default, this is an empty array (‘[]`), which blocks all connections (both public and private) to the Managed Database. If `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.



52
53
54
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 52

def allow_list
  @allow_list
end

#cluster_size ⇒ Object

The number of Linode Instance nodes deployed to the Managed Database. Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.



55
56
57
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 55

def cluster_size
  @cluster_size
end

#created ⇒ Object

Read-only When this Managed Database was created.



72
73
74
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 72

def created
  @created
end

#encrypted ⇒ Object

Whether the Managed Databases is encrypted.



26
27
28
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 26

def encrypted
  @encrypted
end

#engine ⇒ Object

__Filterable__, Read-only The Managed Database engine type.



49
50
51
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 49

def engine
  @engine
end

#hosts ⇒ Object

Returns the value of attribute hosts.



60
61
62
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 60

def hosts
  @hosts
end

#id ⇒ Object

Read-only A unique ID that can be used to identify and reference the Managed Database.



66
67
68
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 66

def id
  @id
end

#label ⇒ Object

__Filterable__ A unique, user-defined string referring to the Managed Database.



23
24
25
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 23

def label
  @label
end

#port ⇒ Object

The access port for this Managed Database.



41
42
43
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 41

def port
  @port
end

#region ⇒ Object

__Filterable__ The [Region](techdocs.akamai.com/linode-api/reference/get-regions) ID for the Managed Database.



75
76
77
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 75

def region
  @region
end

#replication_commit_type ⇒ Object

The synchronization level of the replicating server. Must be ‘local` or `off` for the `asynch` replication type.



46
47
48
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 46

def replication_commit_type
  @replication_commit_type
end

#replication_type ⇒ Object

The replication method used for the Managed Database. Defaults to ‘none` for a single cluster and `asynch` for a high availability cluster. Must be `none` for a single node cluster. Must be `asynch` for a high availability cluster.



29
30
31
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 29

def replication_type
  @replication_type
end

#ssl_connection ⇒ Object

Whether to require SSL credentials to establish a connection to the Managed Database. Run the [Get managed PostgreSQL database credentials](techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-credentials) operation for access information.



38
39
40
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 38

def ssl_connection
  @ssl_connection
end

#status ⇒ Object

__Filterable__, Read-only The operating status of the Managed Database.



63
64
65
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 63

def status
  @status
end

#total_disk_size_gb ⇒ Object

The total disk size of the database in GB.



58
59
60
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 58

def total_disk_size_gb
  @total_disk_size_gb
end

#type ⇒ Object

__Filterable__ The Linode Instance type used by the Managed Database for its nodes.



20
21
22
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 20

def type
  @type
end

#updated ⇒ Object

Read-only When this Managed Database was last updated.



35
36
37
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 35

def updated
  @updated
end

#updates ⇒ Object

Returns the value of attribute updates.



43
44
45
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 43

def updates
  @updates
end

#used_disk_size_gb ⇒ Object

The used space of the database in GB.



69
70
71
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 69

def used_disk_size_gb
  @used_disk_size_gb
end

#version ⇒ Object

__Filterable__, Read-only The Managed Database engine version.



32
33
34
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 32

def version
  @version
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 425

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 100

def self.attribute_map
  {
    :'type' => :'type',
    :'label' => :'label',
    :'encrypted' => :'encrypted',
    :'replication_type' => :'replication_type',
    :'version' => :'version',
    :'updated' => :'updated',
    :'ssl_connection' => :'ssl_connection',
    :'port' => :'port',
    :'updates' => :'updates',
    :'replication_commit_type' => :'replication_commit_type',
    :'engine' => :'engine',
    :'allow_list' => :'allow_list',
    :'cluster_size' => :'cluster_size',
    :'total_disk_size_gb' => :'total_disk_size_gb',
    :'hosts' => :'hosts',
    :'status' => :'status',
    :'id' => :'id',
    :'used_disk_size_gb' => :'used_disk_size_gb',
    :'created' => :'created',
    :'region' => :'region'
  }
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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 401

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



157
158
159
160
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 157

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 131

def self.openapi_types
  {
    :'type' => :'String',
    :'label' => :'String',
    :'encrypted' => :'Boolean',
    :'replication_type' => :'String',
    :'version' => :'String',
    :'updated' => :'Time',
    :'ssl_connection' => :'Boolean',
    :'port' => :'Integer',
    :'updates' => :'PostDatabasesPostgreSqlInstances200ResponseUpdates',
    :'replication_commit_type' => :'String',
    :'engine' => :'String',
    :'allow_list' => :'Array<String>',
    :'cluster_size' => :'Integer',
    :'total_disk_size_gb' => :'Integer',
    :'hosts' => :'GetDatabasesPostgreSqlInstances200ResponseAllOfDataInnerHosts',
    :'status' => :'String',
    :'id' => :'Integer',
    :'used_disk_size_gb' => :'Integer',
    :'created' => :'Time',
    :'region' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 361

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      label == o.label &&
      encrypted == o.encrypted &&
      replication_type == o.replication_type &&
      version == o.version &&
      updated == o.updated &&
      ssl_connection == o.ssl_connection &&
      port == o.port &&
      updates == o.updates &&
      replication_commit_type == o.replication_commit_type &&
      engine == o.engine &&
      allow_list == o.allow_list &&
      cluster_size == o.cluster_size &&
      total_disk_size_gb == o.total_disk_size_gb &&
      hosts == o.hosts &&
      status == o.status &&
      id == o.id &&
      used_disk_size_gb == o.used_disk_size_gb &&
      created == o.created &&
      region == o.region
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 496

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


388
389
390
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 388

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



394
395
396
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 394

def hash
  [type, label, encrypted, replication_type, version, updated, ssl_connection, port, updates, replication_commit_type, engine, allow_list, cluster_size, total_disk_size_gb, hosts, status, id, used_disk_size_gb, created, region].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 270

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@label.nil? && @label.to_s.length > 32
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 32.')
  end

  if !@label.nil? && @label.to_s.length < 3
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 3.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



472
473
474
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 472

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 478

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



466
467
468
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 466

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/linode_openapi_client/models/post_databases_postgre_sql_instances200_response.rb', line 286

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@label.nil? && @label.to_s.length > 32
  return false if !@label.nil? && @label.to_s.length < 3
  replication_type_validator = EnumAttributeValidator.new('String', ["none", "asynch"])
  return false unless replication_type_validator.valid?(@replication_type)
  replication_commit_type_validator = EnumAttributeValidator.new('String', ["true", "local", "remote_write", "remote_apply", "false"])
  return false unless replication_commit_type_validator.valid?(@replication_commit_type)
  cluster_size_validator = EnumAttributeValidator.new('Integer', [1, 3])
  return false unless cluster_size_validator.valid?(@cluster_size)
  status_validator = EnumAttributeValidator.new('String', ["provisioning", "active", "suspending", "suspended", "resuming", "restoring", "failed", "degraded", "updating", "backing_up"])
  return false unless status_validator.valid?(@status)
  true
end