Class: Ionoscloud::KubernetesClusterProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud/models/kubernetes_cluster_properties.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KubernetesClusterProperties

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/models/kubernetes_cluster_properties.rb', line 105

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


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


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


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


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


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


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

Instance Attribute Details

#api_subnet_allow_list ⇒ Object

Access to the K8s API server is restricted to these CIDRs. Traffic, internal to the cluster, is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value is used: 32 for IPv4 and 128 for IPv6.



39
40
41
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 39

def api_subnet_allow_list
  @api_subnet_allow_list
end

#available_upgrade_versions ⇒ Object

List of available versions for upgrading the cluster



31
32
33
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 31

def available_upgrade_versions
  @available_upgrade_versions
end

#k8s_version ⇒ Object

The Kubernetes version the cluster is running. This imposes restrictions on what Kubernetes versions can be run in a cluster’s nodepools. Additionally, not all Kubernetes versions are viable upgrade targets for all prior versions.



24
25
26
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 24

def k8s_version
  @k8s_version
end

#maintenance_window ⇒ Object

Returns the value of attribute maintenance_window.



27
28
29
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 27

def maintenance_window
  @maintenance_window
end

#name ⇒ Object

A Kubernetes cluster name. Valid Kubernetes cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.



20
21
22
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 20

def name
  @name
end

#s3_buckets ⇒ Object

List of S3 bucket configured for K8s usage. For now it contains only an S3 bucket used to store K8s API audit logs



43
44
45
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 43

def s3_buckets
  @s3_buckets
end

#viable_node_pool_versions ⇒ Object

List of versions that may be used for node pools under this cluster



35
36
37
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 35

def viable_node_pool_versions
  @viable_node_pool_versions
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/ionoscloud/models/kubernetes_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/models/kubernetes_cluster_properties.rb', line 46

def self.attribute_map
  {
    
    :'name' => :'name',

    :'k8s_version' => :'k8sVersion',

    :'maintenance_window' => :'maintenanceWindow',

    :'available_upgrade_versions' => :'availableUpgradeVersions',

    :'viable_node_pool_versions' => :'viableNodePoolVersions',

    :'api_subnet_allow_list' => :'apiSubnetAllowList',

    :'s3_buckets' => :'s3Buckets'
  }
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



222
223
224
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 222

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/models/kubernetes_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/models/kubernetes_cluster_properties.rb', line 71

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

    :'k8s_version' => :'String',

    :'maintenance_window' => :'KubernetesMaintenanceWindow',

    :'available_upgrade_versions' => :'Array<String>',

    :'viable_node_pool_versions' => :'Array<String>',

    :'api_subnet_allow_list' => :'Array<String>',

    :'s3_buckets' => :'Array<S3Bucket>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    name == o.name &&
    k8s_version == o.k8s_version &&
    maintenance_window == o.maintenance_window &&
    available_upgrade_versions == o.available_upgrade_versions &&
    viable_node_pool_versions == o.viable_node_pool_versions &&
    api_subnet_allow_list == o.api_subnet_allow_list &&
    s3_buckets == o.s3_buckets
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



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
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 252

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 323

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 229

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


209
210
211
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 209

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



215
216
217
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 215

def hash
  [name, k8s_version, maintenance_window, available_upgrade_versions, viable_node_pool_versions, api_subnet_allow_list, s3_buckets].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
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 156

def list_invalid_properties
  invalid_properties = Array.new
  
  if @name.nil?
    invalid_properties.push('invalid value for "name", 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



299
300
301
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 299

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 305

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



293
294
295
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 293

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



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ionoscloud/models/kubernetes_cluster_properties.rb', line 174

def valid?
  
  return false if @name.nil?






  true
end