Class: IonoscloudDbaasPostgres::CreateClusterProperties

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

Overview

Properties with all data needed to create a new PostgreSQL cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateClusterProperties

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

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


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


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


  if attributes.key?(:'ram')
    self.ram = attributes[:'ram']
  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?(:'location')
    self.location = attributes[:'location']
  end


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


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


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


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


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


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

Instance Attribute Details

#backup_location ⇒ Object

The S3 location where the backups will be stored.



51
52
53
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 51

def backup_location
  @backup_location
end

#connections ⇒ Object

Returns the value of attribute connections.



43
44
45
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 43

def connections
  @connections
end

#cores ⇒ Object

The number of CPU cores per instance.



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

def cores
  @cores
end

#credentials ⇒ Object

Returns the value of attribute credentials.



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

def credentials
  @credentials
end

#display_name ⇒ Object

The friendly name of your cluster.



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

def display_name
  @display_name
end

#from_backup ⇒ Object

Returns the value of attribute from_backup.



67
68
69
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 67

def from_backup
  @from_backup
end

#instances ⇒ Object

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



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

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.



47
48
49
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 47

def location
  @location
end

#maintenance_window ⇒ Object

Returns the value of attribute maintenance_window.



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

def maintenance_window
  @maintenance_window
end

#postgres_version ⇒ Object

The PostgreSQL version of your cluster.



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

def postgres_version
  @postgres_version
end

#ram ⇒ Object

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



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

def ram
  @ram
end

#storage_size ⇒ Object

The amount of storage per instance in megabytes.



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

def storage_size
  @storage_size
end

#storage_type ⇒ Object

Returns the value of attribute storage_type.



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

def storage_type
  @storage_type
end

#synchronization_mode ⇒ Object

Returns the value of attribute synchronization_mode.



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

def synchronization_mode
  @synchronization_mode
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
98
99
100
101
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 70

def self.attribute_map
  {
    
    :'postgres_version' => :'postgresVersion',

    :'instances' => :'instances',

    :'cores' => :'cores',

    :'ram' => :'ram',

    :'storage_size' => :'storageSize',

    :'storage_type' => :'storageType',

    :'connections' => :'connections',

    :'location' => :'location',

    :'backup_location' => :'backupLocation',

    :'display_name' => :'displayName',

    :'maintenance_window' => :'maintenanceWindow',

    :'credentials' => :'credentials',

    :'synchronization_mode' => :'synchronizationMode',

    :'from_backup' => :'fromBackup'
  }
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



516
517
518
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 516

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 143

def self.openapi_nullable
  Set.new([
    













  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
135
136
137
138
139
140
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 109

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

    :'instances' => :'Integer',

    :'cores' => :'Integer',

    :'ram' => :'Integer',

    :'storage_size' => :'Integer',

    :'storage_type' => :'StorageType',

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

    :'location' => :'String',

    :'backup_location' => :'String',

    :'display_name' => :'String',

    :'maintenance_window' => :'MaintenanceWindow',

    :'credentials' => :'DBUser',

    :'synchronization_mode' => :'SynchronizationMode',

    :'from_backup' => :'CreateRestoreRequest'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 482

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    postgres_version == o.postgres_version &&
    instances == o.instances &&
    cores == o.cores &&
    ram == o.ram &&
    storage_size == o.storage_size &&
    storage_type == o.storage_type &&
    connections == o.connections &&
    location == o.location &&
    backup_location == o.backup_location &&
    display_name == o.display_name &&
    maintenance_window == o.maintenance_window &&
    credentials == o.credentials &&
    synchronization_mode == o.synchronization_mode &&
    from_backup == o.from_backup
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



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 546

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



617
618
619
620
621
622
623
624
625
626
627
628
629
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 617

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



523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 523

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



509
510
511
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 509

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



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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 250

def list_invalid_properties
  invalid_properties = Array.new
  
  if @postgres_version.nil?
    invalid_properties.push('invalid value for "postgres_version", postgres_version cannot be nil.')
  end


  if @instances.nil?
    invalid_properties.push('invalid value for "instances", instances cannot be nil.')
  end

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

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


  if @cores.nil?
    invalid_properties.push('invalid value for "cores", cores cannot be nil.')
  end

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


  if @ram.nil?
    invalid_properties.push('invalid value for "ram", ram cannot be nil.')
  end

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


  if @storage_size.nil?
    invalid_properties.push('invalid value for "storage_size", storage_size cannot be nil.')
  end

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

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


  if @storage_type.nil?
    invalid_properties.push('invalid value for "storage_type", storage_type cannot be nil.')
  end


  if @connections.nil?
    invalid_properties.push('invalid value for "connections", connections cannot be nil.')
  end

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

  if @connections.length < 1
    invalid_properties.push('invalid value for "connections", number of items must be greater than or equal to 1.')
  end


  if @location.nil?
    invalid_properties.push('invalid value for "location", location cannot be nil.')
  end



  if @display_name.nil?
    invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
  end



  if @credentials.nil?
    invalid_properties.push('invalid value for "credentials", credentials cannot be nil.')
  end


  if @synchronization_mode.nil?
    invalid_properties.push('invalid value for "synchronization_mode", synchronization_mode cannot be nil.')
  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



593
594
595
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 593

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



599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 599

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



587
588
589
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 587

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb', line 347

def valid?
  
  return false if @postgres_version.nil?

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

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

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

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

  return false if @storage_type.nil?

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

  return false if @location.nil?


  return false if @display_name.nil?


  return false if @credentials.nil?

  return false if @synchronization_mode.nil?

  true
end