Class: OCI::ContainerEngine::Models::Cluster

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

Overview

A Kubernetes cluster. Avoid entering confidential information.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Cluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

  self.available_kubernetes_upgrades = attributes[:'availableKubernetesUpgrades'] if attributes[:'availableKubernetesUpgrades']

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

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

Instance Attribute Details

#available_kubernetes_upgrades ⇒ Array<String>

Available Kubernetes versions to which the clusters masters may be upgraded.

Returns:

  • (Array<String>) 


67
68
69
 
# File 'lib/oci/container_engine/models/cluster.rb', line 67

def available_kubernetes_upgrades
  @available_kubernetes_upgrades
end

#compartment_id ⇒ String

The OCID of the compartment in which the cluster exists.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#endpoints ⇒ OCI::ContainerEngine::Models::ClusterEndpoints

Endpoints served up by the cluster masters.

Returns:



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

def endpoints
  @endpoints
end

#id ⇒ String

The OCID of the cluster.

Returns:

  • (String) 


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

def id
  @id
end

#kms_key_id ⇒ String

The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.

Returns:

  • (String) 


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

def kms_key_id
  @kms_key_id
end

#kubernetes_version ⇒ String

The version of Kubernetes running on the cluster masters.

Returns:

  • (String) 


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

def kubernetes_version
  @kubernetes_version
end

#lifecycle_details ⇒ String

Details about the state of the cluster masters.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The state of the cluster masters.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#metadata ⇒ OCI::ContainerEngine::Models::ClusterMetadata

Metadata about the cluster.

Returns:



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

def metadata
  @metadata
end

#name ⇒ String

The name of the cluster.

Returns:

  • (String) 


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

def name
  @name
end

#options ⇒ OCI::ContainerEngine::Models::ClusterCreateOptions

Optional attributes for the cluster.

Returns:



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

def options
  @options
end

#vcn_id ⇒ String

The OCID of the virtual cloud network (VCN) in which the cluster exists.

Returns:

  • (String) 


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

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/container_engine/models/cluster.rb', line 70

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'vcn_id': :'vcnId',
    'kubernetes_version': :'kubernetesVersion',
    'kms_key_id': :'kmsKeyId',
    'options': :'options',
    'metadata': :'metadata',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'endpoints': :'endpoints',
    'available_kubernetes_upgrades': :'availableKubernetesUpgrades'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'compartment_id': :'String',
    'vcn_id': :'String',
    'kubernetes_version': :'String',
    'kms_key_id': :'String',
    'options': :'OCI::ContainerEngine::Models::ClusterCreateOptions',
    'metadata': :'OCI::ContainerEngine::Models::ClusterMetadata',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'endpoints': :'OCI::ContainerEngine::Models::ClusterEndpoints',
    'available_kubernetes_upgrades': :'Array<String>'
    # 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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/container_engine/models/cluster.rb', line 206

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    vcn_id == other.vcn_id &&
    kubernetes_version == other.kubernetes_version &&
    kms_key_id == other.kms_key_id &&
    options == other.options &&
    metadata == other.metadata &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    endpoints == other.endpoints &&
    available_kubernetes_upgrades == other.available_kubernetes_upgrades
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/container_engine/models/cluster.rb', line 247

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


227
228
229
 
# File 'lib/oci/container_engine/models/cluster.rb', line 227

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/oci/container_engine/models/cluster.rb', line 236

def hash
  [id, name, compartment_id, vcn_id, kubernetes_version, kms_key_id, options, metadata, lifecycle_state, lifecycle_details, endpoints, available_kubernetes_upgrades].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/container_engine/models/cluster.rb', line 280

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



274
275
276
 
# File 'lib/oci/container_engine/models/cluster.rb', line 274

def to_s
  to_hash.to_s
end