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):



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
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
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 146

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_source = attributes[:'nodeSource'] if attributes[:'nodeSource']

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

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

  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']

  self.node_config_details = attributes[:'nodeConfigDetails'] if attributes[:'nodeConfigDetails']

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

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

Instance Attribute Details

#cluster_id ⇒ String

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

Returns:

  • (String) 


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

def cluster_id
  @cluster_id
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#id ⇒ String

The OCID of the node pool.

Returns:

  • (String) 


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

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:



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

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) 


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

def kubernetes_version
  @kubernetes_version
end

#name ⇒ String

The name of the node pool.

Returns:

  • (String) 


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

def name
  @name
end

#node_config_details ⇒ OCI::ContainerEngine::Models::NodePoolNodeConfigDetails

The configuration of nodes in the node pool.

Returns:



74
75
76
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 74

def node_config_details
  @node_config_details
end

#node_image_id ⇒ String

Deprecated. see ‘nodeSource`. The OCID of the image running on the nodes in the node pool.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 37

def node_image_id
  @node_image_id
end

#node_image_name ⇒ String

Deprecated. see ‘nodeSource`. The name of the image running on the nodes in the node pool.

Returns:

  • (String) 


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

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>) 


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

def node_metadata
  @node_metadata
end

#node_shape ⇒ String

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

Returns:

  • (String) 


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

def node_shape
  @node_shape
end

#node_source ⇒ OCI::ContainerEngine::Models::NodeSourceOption

Source running on the nodes in the node pool.

Returns:



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

def node_source
  @node_source
end

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

The nodes in the node pool.

Returns:

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


70
71
72
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 70

def nodes
  @nodes
end

#quantity_per_subnet ⇒ Integer

The number of nodes in each subnet.

Returns:

  • (Integer) 


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

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) 


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

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>) 


66
67
68
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 66

def subnet_ids
  @subnet_ids
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 77

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_source': :'nodeSource',
    'node_shape': :'nodeShape',
    'initial_node_labels': :'initialNodeLabels',
    'ssh_public_key': :'sshPublicKey',
    'quantity_per_subnet': :'quantityPerSubnet',
    'subnet_ids': :'subnetIds',
    'nodes': :'nodes',
    'node_config_details': :'nodeConfigDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 101

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_source': :'OCI::ContainerEngine::Models::NodeSourceOption',
    '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>',
    'node_config_details': :'OCI::ContainerEngine::Models::NodePoolNodeConfigDetails'
    # 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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 244

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_source == other.node_source &&
    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 &&
    node_config_details == other.node_config_details
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 289

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


269
270
271
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 269

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 278

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
331
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 322

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



316
317
318
 
# File 'lib/oci/container_engine/models/node_pool.rb', line 316

def to_s
  to_hash.to_s
end