Class: OCI::ContainerEngine::Models::CreateVirtualNodePoolDetails

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

Overview

The properties that define a request to create a virtual node pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVirtualNodePoolDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 122

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

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

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

  self.initial_virtual_node_labels = attributes[:'initialVirtualNodeLabels'] if attributes[:'initialVirtualNodeLabels']

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

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

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

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

  self.placement_configurations = attributes[:'placementConfigurations'] if attributes[:'placementConfigurations']

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

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

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

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

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

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

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

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

Instance Attribute Details

#cluster_id ⇒ String

[Required] The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 17

def cluster_id
  @cluster_id
end

#compartment_id ⇒ String

[Required] Compartment of the virtual node pool.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 13

def compartment_id
  @compartment_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>>) 


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Display name of the virtual node pool. This is a non-unique value.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 21

def display_name
  @display_name
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>) 


52
53
54
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 52

def freeform_tags
  @freeform_tags
end

#initial_virtual_node_labels ⇒ Array<OCI::ContainerEngine::Models::InitialVirtualNodeLabel>

Initial labels that will be added to the Kubernetes Virtual Node object when it registers.

Returns:



25
26
27
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 25

def initial_virtual_node_labels
  @initial_virtual_node_labels
end

#nsg_ids ⇒ Array<String>

List of network security group id's applied to the Virtual Node VNIC.

Returns:

  • (Array<String>) 


41
42
43
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 41

def nsg_ids
  @nsg_ids
end

#placement_configurations ⇒ Array<OCI::ContainerEngine::Models::PlacementConfiguration>

[Required] The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations

Returns:



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

def placement_configurations
  @placement_configurations
end

#pod_configuration ⇒ OCI::ContainerEngine::Models::PodConfiguration

The pod configuration for pods run on virtual nodes of this virtual node pool.

Returns:



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

def pod_configuration
  @pod_configuration
end

#size ⇒ Integer

The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 33

def size
  @size
end

#taints ⇒ Array<OCI::ContainerEngine::Models::Taint>

A taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.

Returns:



29
30
31
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 29

def taints
  @taints
end

#virtual_node_tags ⇒ OCI::ContainerEngine::Models::VirtualNodeTags

Returns:



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

def virtual_node_tags
  @virtual_node_tags
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'cluster_id': :'clusterId',
    'display_name': :'displayName',
    'initial_virtual_node_labels': :'initialVirtualNodeLabels',
    'taints': :'taints',
    'size': :'size',
    'placement_configurations': :'placementConfigurations',
    'nsg_ids': :'nsgIds',
    'pod_configuration': :'podConfiguration',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'virtual_node_tags': :'virtualNodeTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'cluster_id': :'String',
    'display_name': :'String',
    'initial_virtual_node_labels': :'Array<OCI::ContainerEngine::Models::InitialVirtualNodeLabel>',
    'taints': :'Array<OCI::ContainerEngine::Models::Taint>',
    'size': :'Integer',
    'placement_configurations': :'Array<OCI::ContainerEngine::Models::PlacementConfiguration>',
    'nsg_ids': :'Array<String>',
    'pod_configuration': :'OCI::ContainerEngine::Models::PodConfiguration',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'virtual_node_tags': :'OCI::ContainerEngine::Models::VirtualNodeTags'
    # 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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 200

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    cluster_id == other.cluster_id &&
    display_name == other.display_name &&
    initial_virtual_node_labels == other.initial_virtual_node_labels &&
    taints == other.taints &&
    size == other.size &&
    placement_configurations == other.placement_configurations &&
    nsg_ids == other.nsg_ids &&
    pod_configuration == other.pod_configuration &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    virtual_node_tags == other.virtual_node_tags
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



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

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


221
222
223
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 221

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 230

def hash
  [compartment_id, cluster_id, display_name, initial_virtual_node_labels, taints, size, placement_configurations, nsg_ids, pod_configuration, freeform_tags, defined_tags, virtual_node_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
283
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 274

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



268
269
270
 
# File 'lib/oci/container_engine/models/create_virtual_node_pool_details.rb', line 268

def to_s
  to_hash.to_s
end