Class: IonoscloudDbaasMongo::CreateClusterProperties

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

Overview

The properties with all data needed to create a new MongoDB 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



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 105

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


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


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


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

Instance Attribute Details

#connections ⇒ Object

Returns the value of attribute connections.



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

def connections
  @connections
end

#display_name ⇒ Object

The name of your cluster.



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

def display_name
  @display_name
end

#instances ⇒ Object

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



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

def instances
  @instances
end

#location ⇒ Object

The physical location where the cluster will be created. This is the location where all your instances will be located. This property is immutable.



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

def location
  @location
end

#maintenance_window ⇒ Object

Returns the value of attribute maintenance_window.



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

def maintenance_window
  @maintenance_window
end

#mongo_db_version ⇒ Object

The MongoDB version of your cluster.



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

def mongo_db_version
  @mongo_db_version
end

#template_id ⇒ Object

The unique ID of the template, which specifies the number of cores, storage size, and memory. You cannot downgrade to a smaller template or minor edition (e.g. from business to playground). To get a list of all templates to confirm the changes use the /templates endpoint.



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

def template_id
  @template_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 46

def self.attribute_map
  {
    
    :'template_id' => :'templateID',

    :'mongo_db_version' => :'mongoDBVersion',

    :'instances' => :'instances',

    :'connections' => :'connections',

    :'location' => :'location',

    :'display_name' => :'displayName',

    :'maintenance_window' => :'maintenanceWindow'
  }
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



270
271
272
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 270

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 91

def self.openapi_nullable
  Set.new([
    






  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 71

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

    :'mongo_db_version' => :'String',

    :'instances' => :'Integer',

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

    :'location' => :'String',

    :'display_name' => :'String',

    :'maintenance_window' => :'MaintenanceWindow'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    template_id == o.template_id &&
    mongo_db_version == o.mongo_db_version &&
    instances == o.instances &&
    connections == o.connections &&
    location == o.location &&
    display_name == o.display_name &&
    maintenance_window == o.maintenance_window
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



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

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 = IonoscloudDbaasMongo.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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 371

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 277

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


257
258
259
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



263
264
265
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 263

def hash
  [template_id, mongo_db_version, instances, connections, location, display_name, maintenance_window].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



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

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



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


  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



347
348
349
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 347

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 353

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



341
342
343
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 341

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/ionoscloud-dbaas-mongo/models/create_cluster_properties.rb', line 198

def valid?
  
  return false if @template_id.nil?


  return false if @instances.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?

  true
end