Class: OCI::ContainerEngine::Models::NodePoolNodeConfigDetails

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

Overview

The size and placement configuration of nodes in the node pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NodePoolNodeConfigDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 111

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.size = attributes[:'size'] if attributes[:'size']

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

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

  self.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

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

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

  self.compute_cluster_id = attributes[:'computeClusterId'] if attributes[:'computeClusterId']

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

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

  self.is_pv_encryption_in_transit_enabled = attributes[:'isPvEncryptionInTransitEnabled'] unless attributes[:'isPvEncryptionInTransitEnabled'].nil?
  self.is_pv_encryption_in_transit_enabled = false if is_pv_encryption_in_transit_enabled.nil? && !attributes.key?(:'isPvEncryptionInTransitEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_pv_encryption_in_transit_enabled = attributes[:'is_pv_encryption_in_transit_enabled'] unless attributes[:'is_pv_encryption_in_transit_enabled'].nil?
  self.is_pv_encryption_in_transit_enabled = false if is_pv_encryption_in_transit_enabled.nil? && !attributes.key?(:'isPvEncryptionInTransitEnabled') && !attributes.key?(:'is_pv_encryption_in_transit_enabled') # rubocop:disable Style/StringLiterals

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.placement_configs = attributes[:'placementConfigs'] if attributes[:'placementConfigs']

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

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

  self.node_pool_pod_network_option_details = attributes[:'nodePoolPodNetworkOptionDetails'] if attributes[:'nodePoolPodNetworkOptionDetails']

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

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

Instance Attribute Details

#compute_cluster_id ⇒ String

The OCID of the Compute Cluster to be associated with the worker node instance.

Returns:

  • (String) 


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

def compute_cluster_id
  @compute_cluster_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


45
46
47
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 45

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


38
39
40
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 38

def freeform_tags
  @freeform_tags
end

#is_pv_encryption_in_transit_enabled ⇒ BOOLEAN

Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.

Returns:

  • (BOOLEAN) 


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

def is_pv_encryption_in_transit_enabled
  @is_pv_encryption_in_transit_enabled
end

#kms_key_id ⇒ String

The OCID of the Key Management Service key assigned to the boot volume.

Returns:

  • (String) 


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

def kms_key_id
  @kms_key_id
end

#node_pool_pod_network_option_details ⇒ OCI::ContainerEngine::Models::NodePoolPodNetworkOptionDetails

The CNI related configuration of pods in the node pool.

Returns:



60
61
62
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 60

def node_pool_pod_network_option_details
  @node_pool_pod_network_option_details
end

#nsg_ids ⇒ Array<String>

The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup.

Returns:

  • (Array<String>) 


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

def nsg_ids
  @nsg_ids
end

#placement_configs ⇒ Array<OCI::ContainerEngine::Models::NodePoolPlacementConfigDetails>

The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node.

To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.

Returns:



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

def placement_configs
  @placement_configs
end

#size ⇒ Integer

The number of nodes in the node pool.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 14

def size
  @size
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 63

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'size': :'size',
    'nsg_ids': :'nsgIds',
    'kms_key_id': :'kmsKeyId',
    'compute_cluster_id': :'computeClusterId',
    'is_pv_encryption_in_transit_enabled': :'isPvEncryptionInTransitEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'placement_configs': :'placementConfigs',
    'node_pool_pod_network_option_details': :'nodePoolPodNetworkOptionDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 80

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'size': :'Integer',
    'nsg_ids': :'Array<String>',
    'kms_key_id': :'String',
    'compute_cluster_id': :'String',
    'is_pv_encryption_in_transit_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'placement_configs': :'Array<OCI::ContainerEngine::Models::NodePoolPlacementConfigDetails>',
    'node_pool_pod_network_option_details': :'OCI::ContainerEngine::Models::NodePoolPodNetworkOptionDetails'
    # 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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 177

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

  self.class == other.class &&
    size == other.size &&
    nsg_ids == other.nsg_ids &&
    kms_key_id == other.kms_key_id &&
    compute_cluster_id == other.compute_cluster_id &&
    is_pv_encryption_in_transit_enabled == other.is_pv_encryption_in_transit_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    placement_configs == other.placement_configs &&
    node_pool_pod_network_option_details == other.node_pool_pod_network_option_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



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

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


195
196
197
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 204

def hash
  [size, nsg_ids, kms_key_id, compute_cluster_id, is_pv_encryption_in_transit_enabled, freeform_tags, defined_tags, placement_configs, node_pool_pod_network_option_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 248

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



242
243
244
 
# File 'lib/oci/container_engine/models/node_pool_node_config_details.rb', line 242

def to_s
  to_hash.to_s
end