Class: IonoscloudDbaasPostgres::ClusterProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb

Overview

Properties of a database cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClusterProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
233
234
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 157

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IonoscloudDbaasPostgres::ClusterProperties` 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 `IonoscloudDbaasPostgres::ClusterProperties`. 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?(:'display_name')
    self.display_name = attributes[:'display_name']
  end


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


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


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


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


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


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


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


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


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


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


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


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

Instance Attribute Details

#backup_location ⇒ Object

The S3 location where the backups will be stored.



37
38
39
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 37

def backup_location
  @backup_location
end

#connections ⇒ Object

Returns the value of attribute connections.



59
60
61
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 59

def connections
  @connections
end

#cores ⇒ Object

The number of CPU cores per instance.



49
50
51
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 49

def cores
  @cores
end

#display_name ⇒ Object

The friendly name of your cluster.



21
22
23
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 21

def display_name
  @display_name
end

#dns_name ⇒ Object

The DNS name pointing to your cluster.



33
34
35
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 33

def dns_name
  @dns_name
end

#instances ⇒ Object

The total number of instances in the cluster (one master and n-1 standbys).



41
42
43
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 41

def instances
  @instances
end

#location ⇒ Object

The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation.



29
30
31
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 29

def location
  @location
end

#maintenance_window ⇒ Object

Returns the value of attribute maintenance_window.



62
63
64
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 62

def maintenance_window
  @maintenance_window
end

#postgres_version ⇒ Object

The PostgreSQL version of your cluster.



25
26
27
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 25

def postgres_version
  @postgres_version
end

#ram ⇒ Object

The amount of memory per instance in megabytes. Has to be a multiple of 1024.



45
46
47
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 45

def ram
  @ram
end

#storage_size ⇒ Object

The amount of storage per instance in megabytes.



53
54
55
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 53

def storage_size
  @storage_size
end

#storage_type ⇒ Object

Returns the value of attribute storage_type.



56
57
58
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 56

def storage_type
  @storage_type
end

#synchronization_mode ⇒ Object

Returns the value of attribute synchronization_mode.



65
66
67
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 65

def synchronization_mode
  @synchronization_mode
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



100
101
102
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 100

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 68

def self.attribute_map
  {
    
    :'display_name' => :'displayName',

    :'postgres_version' => :'postgresVersion',

    :'location' => :'location',

    :'dns_name' => :'dnsName',

    :'backup_location' => :'backupLocation',

    :'instances' => :'instances',

    :'ram' => :'ram',

    :'cores' => :'cores',

    :'storage_size' => :'storageSize',

    :'storage_type' => :'storageType',

    :'connections' => :'connections',

    :'maintenance_window' => :'maintenanceWindow',

    :'synchronization_mode' => :'synchronizationMode'
  }
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



425
426
427
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 425

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 137

def self.openapi_nullable
  Set.new([
    












  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 105

def self.openapi_types
  {
    
    :'display_name' => :'String',

    :'postgres_version' => :'String',

    :'location' => :'String',

    :'dns_name' => :'String',

    :'backup_location' => :'String',

    :'instances' => :'Integer',

    :'ram' => :'Integer',

    :'cores' => :'Integer',

    :'storage_size' => :'Integer',

    :'storage_type' => :'StorageType',

    :'connections' => :'Array<Connection>',

    :'maintenance_window' => :'MaintenanceWindow',

    :'synchronization_mode' => :'SynchronizationMode'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 392

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    display_name == o.display_name &&
    postgres_version == o.postgres_version &&
    location == o.location &&
    dns_name == o.dns_name &&
    backup_location == o.backup_location &&
    instances == o.instances &&
    ram == o.ram &&
    cores == o.cores &&
    storage_size == o.storage_size &&
    storage_type == o.storage_type &&
    connections == o.connections &&
    maintenance_window == o.maintenance_window &&
    synchronization_mode == o.synchronization_mode
end

#_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



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 455

def _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 = IonoscloudDbaasPostgres.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 526

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

#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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 432

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


412
413
414
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 412

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



418
419
420
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 418

def hash
  [display_name, postgres_version, location, dns_name, backup_location, instances, ram, cores, storage_size, storage_type, connections, maintenance_window, synchronization_mode].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



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
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 238

def list_invalid_properties
  invalid_properties = Array.new
  





  if !@instances.nil? && @instances > 5
    invalid_properties.push('invalid value for "instances", must be smaller than or equal to 5.')
  end

  if !@instances.nil? && @instances < 1
    invalid_properties.push('invalid value for "instances", must be greater than or equal to 1.')
  end


  if !@ram.nil? && @ram < 2048
    invalid_properties.push('invalid value for "ram", must be greater than or equal to 2048.')
  end


  if !@cores.nil? && @cores < 1
    invalid_properties.push('invalid value for "cores", must be greater than or equal to 1.')
  end


  if !@storage_size.nil? && @storage_size > 2097152
    invalid_properties.push('invalid value for "storage_size", must be smaller than or equal to 2097152.')
  end

  if !@storage_size.nil? && @storage_size < 2048
    invalid_properties.push('invalid value for "storage_size", must be greater than or equal to 2048.')
  end



  if !@connections.nil? && @connections.length > 1
    invalid_properties.push('invalid value for "connections", number of items must be less than or equal to 1.')
  end

  if !@connections.nil? && @connections.length < 1
    invalid_properties.push('invalid value for "connections", number of items must be greater than or equal to 1.')
  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



502
503
504
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 502

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



508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 508

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



496
497
498
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 496

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb', line 290

def valid?
  





  return false if !@instances.nil? && @instances > 5
  return false if !@instances.nil? && @instances < 1

  return false if !@ram.nil? && @ram < 2048

  return false if !@cores.nil? && @cores < 1

  return false if !@storage_size.nil? && @storage_size > 2097152
  return false if !@storage_size.nil? && @storage_size < 2048


  return false if !@connections.nil? && @connections.length > 1
  return false if !@connections.nil? && @connections.length < 1


  true
end