Class: OCI::ContainerEngine::Models::NodePool

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/container_engine/models/node_pool.rb

Overview

A pool of compute nodes attached to a cluster. Avoid entering confidential information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NodePool

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :cluster_id (String) —

    The value to assign to the #cluster_id property

  • :name (String) —

    The value to assign to the #name property

  • :kubernetes_version (String) —

    The value to assign to the #kubernetes_version property

  • :node_metadata (Hash<String, String>) —

    The value to assign to the #node_metadata property

  • :node_image_id (String) —

    The value to assign to the #node_image_id property

  • :node_image_name (String) —

    The value to assign to the #node_image_name property

  • :node_shape (String) —

    The value to assign to the #node_shape property

  • :initial_node_labels (Array<OCI::ContainerEngine::Models::KeyValue>) —

    The value to assign to the #initial_node_labels property

  • :ssh_public_key (String) —

    The value to assign to the #ssh_public_key property

  • :quantity_per_subnet (Integer) —

    The value to assign to the #quantity_per_subnet property

  • :subnet_ids (Array<String>) —

    The value to assign to the #subnet_ids property

  • :nodes (Array<OCI::ContainerEngine::Models::Node>) —

    The value to assign to the #nodes property



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 129

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.cluster_id = attributes[:'clusterId'] if attributes[:'clusterId']

  raise 'You cannot provide both :clusterId and :cluster_id' if attributes.key?(:'clusterId') && attributes.key?(:'cluster_id')

  self.cluster_id = attributes[:'cluster_id'] if attributes[:'cluster_id']

  self.name = attributes[:'name'] if attributes[:'name']

  self.kubernetes_version = attributes[:'kubernetesVersion'] if attributes[:'kubernetesVersion']

  raise 'You cannot provide both :kubernetesVersion and :kubernetes_version' if attributes.key?(:'kubernetesVersion') && attributes.key?(:'kubernetes_version')

  self.kubernetes_version = attributes[:'kubernetes_version'] if attributes[:'kubernetes_version']

  self.node_metadata = attributes[:'nodeMetadata'] if attributes[:'nodeMetadata']

  raise 'You cannot provide both :nodeMetadata and :node_metadata' if attributes.key?(:'nodeMetadata') && attributes.key?(:'node_metadata')

  self.node_metadata = attributes[:'node_metadata'] if attributes[:'node_metadata']

  self.node_image_id = attributes[:'nodeImageId'] if attributes[:'nodeImageId']

  raise 'You cannot provide both :nodeImageId and :node_image_id' if attributes.key?(:'nodeImageId') && attributes.key?(:'node_image_id')

  self.node_image_id = attributes[:'node_image_id'] if attributes[:'node_image_id']

  self.node_image_name = attributes[:'nodeImageName'] if attributes[:'nodeImageName']

  raise 'You cannot provide both :nodeImageName and :node_image_name' if attributes.key?(:'nodeImageName') && attributes.key?(:'node_image_name')

  self.node_image_name = attributes[:'node_image_name'] if attributes[:'node_image_name']

  self.node_shape = attributes[:'nodeShape'] if attributes[:'nodeShape']

  raise 'You cannot provide both :nodeShape and :node_shape' if attributes.key?(:'nodeShape') && attributes.key?(:'node_shape')

  self.node_shape = attributes[:'node_shape'] if attributes[:'node_shape']

  self.initial_node_labels = attributes[:'initialNodeLabels'] if attributes[:'initialNodeLabels']

  raise 'You cannot provide both :initialNodeLabels and :initial_node_labels' if attributes.key?(:'initialNodeLabels') && attributes.key?(:'initial_node_labels')

  self.initial_node_labels = attributes[:'initial_node_labels'] if attributes[:'initial_node_labels']

  self.ssh_public_key = attributes[:'sshPublicKey'] if attributes[:'sshPublicKey']

  raise 'You cannot provide both :sshPublicKey and :ssh_public_key' if attributes.key?(:'sshPublicKey') && attributes.key?(:'ssh_public_key')

  self.ssh_public_key = attributes[:'ssh_public_key'] if attributes[:'ssh_public_key']

  self.quantity_per_subnet = attributes[:'quantityPerSubnet'] if attributes[:'quantityPerSubnet']

  raise 'You cannot provide both :quantityPerSubnet and :quantity_per_subnet' if attributes.key?(:'quantityPerSubnet') && attributes.key?(:'quantity_per_subnet')

  self.quantity_per_subnet = attributes[:'quantity_per_subnet'] if attributes[:'quantity_per_subnet']

  self.subnet_ids = attributes[:'subnetIds'] if attributes[:'subnetIds']

  raise 'You cannot provide both :subnetIds and :subnet_ids' if attributes.key?(:'subnetIds') && attributes.key?(:'subnet_ids')

  self.subnet_ids = attributes[:'subnet_ids'] if attributes[:'subnet_ids']

  self.nodes = attributes[:'nodes'] if attributes[:'nodes']
end

Instance Attribute Details

#cluster_id ⇒ String

The OCID of the cluster to which this node pool is attached.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 19

def cluster_id
  @cluster_id
end

#compartment_id ⇒ String

The OCID of the compartment in which the node pool exists.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 15

def compartment_id
  @compartment_id
end

#id ⇒ String

The OCID of the node pool.

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 11

def id
  @id
end

#initial_node_labels ⇒ Array<OCI::ContainerEngine::Models::KeyValue>

A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

Returns:



47
48
49
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 47

def initial_node_labels
  @initial_node_labels
end

#kubernetes_version ⇒ String

The version of Kubernetes running on the nodes in the node pool.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 27

def kubernetes_version
  @kubernetes_version
end

#name ⇒ String

The name of the node pool.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 23

def name
  @name
end

#node_image_id ⇒ String

The OCID of the image running on the nodes in the node pool.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 35

def node_image_id
  @node_image_id
end

#node_image_name ⇒ String

The name of the image running on the nodes in the node pool.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 39

def node_image_name
  @node_image_name
end

#node_metadata ⇒ Hash<String, String>

A list of key/value pairs to add to each underlying OCI instance in the node pool.

Returns:

  • (Hash<String, String>) 


31
32
33
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 31

def node_metadata
  @node_metadata
end

#node_shape ⇒ String

The name of the node shape of the nodes in the node pool.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 43

def node_shape
  @node_shape
end

#nodes ⇒ Array<OCI::ContainerEngine::Models::Node>

The nodes in the node pool.

Returns:

  • (Array<OCI::ContainerEngine::Models::Node>) 


63
64
65
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 63

def nodes
  @nodes
end

#quantity_per_subnet ⇒ Integer

The number of nodes in each subnet.

Returns:

  • (Integer) 


55
56
57
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 55

def quantity_per_subnet
  @quantity_per_subnet
end

#ssh_public_key ⇒ String

The SSH public key on each node in the node pool.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 51

def ssh_public_key
  @ssh_public_key
end

#subnet_ids ⇒ Array<String>

The OCIDs of the subnets in which to place nodes for this node pool.

Returns:

  • (Array<String>) 


59
60
61
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 59

def subnet_ids
  @subnet_ids
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'cluster_id': :'clusterId',
    'name': :'name',
    'kubernetes_version': :'kubernetesVersion',
    'node_metadata': :'nodeMetadata',
    'node_image_id': :'nodeImageId',
    'node_image_name': :'nodeImageName',
    'node_shape': :'nodeShape',
    'initial_node_labels': :'initialNodeLabels',
    'ssh_public_key': :'sshPublicKey',
    'quantity_per_subnet': :'quantityPerSubnet',
    'subnet_ids': :'subnetIds',
    'nodes': :'nodes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'cluster_id': :'String',
    'name': :'String',
    'kubernetes_version': :'String',
    'node_metadata': :'Hash<String, String>',
    'node_image_id': :'String',
    'node_image_name': :'String',
    'node_shape': :'String',
    'initial_node_labels': :'Array<OCI::ContainerEngine::Models::KeyValue>',
    'ssh_public_key': :'String',
    'quantity_per_subnet': :'Integer',
    'subnet_ids': :'Array<String>',
    'nodes': :'Array<OCI::ContainerEngine::Models::Node>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 215

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    cluster_id == other.cluster_id &&
    name == other.name &&
    kubernetes_version == other.kubernetes_version &&
    node_metadata == other.node_metadata &&
    node_image_id == other.node_image_id &&
    node_image_name == other.node_image_name &&
    node_shape == other.node_shape &&
    initial_node_labels == other.initial_node_labels &&
    ssh_public_key == other.ssh_public_key &&
    quantity_per_subnet == other.quantity_per_subnet &&
    subnet_ids == other.subnet_ids &&
    nodes == other.nodes
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 258

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 238

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



247
248
249
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 247

def hash
  [id, compartment_id, cluster_id, name, kubernetes_version, node_metadata, node_image_id, node_image_name, node_shape, initial_node_labels, ssh_public_key, quantity_per_subnet, subnet_ids, nodes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 291

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



285
286
287
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 285

def to_s
  to_hash.to_s
end