Class: OCI::ContainerEngine::Models::CreateClusterDetails

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

Overview

The properties that define a request to create a cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 66

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment in which to create the cluster.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#kubernetes_version ⇒ String

[Required] The version of Kubernetes to install into the cluster masters.

Returns:

  • (String) 


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

def kubernetes_version
  @kubernetes_version
end

#name ⇒ String

[Required] The name of the cluster. Avoid entering confidential information.

Returns:

  • (String) 


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

def name
  @name
end

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

Optional attributes for the cluster.

Returns:



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

def options
  @options
end

#vcn_id ⇒ String

[Required] The OCID of the virtual cloud network (VCN) in which to create the cluster.

Returns:

  • (String) 


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

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'compartment_id': :'compartmentId',
    'vcn_id': :'vcnId',
    'kubernetes_version': :'kubernetesVersion',
    'options': :'options'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'compartment_id': :'String',
    'vcn_id': :'String',
    'kubernetes_version': :'String',
    'options': :'OCI::ContainerEngine::Models::ClusterCreateOptions'
    # 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



102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 102

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    name == other.name &&
    compartment_id == other.compartment_id &&
    vcn_id == other.vcn_id &&
    kubernetes_version == other.kubernetes_version &&
    options == other.options
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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 135

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


115
116
117
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 124

def hash
  [name, compartment_id, vcn_id, kubernetes_version, options].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 167

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



161
162
163
 
# File 'lib/oci/container_engine/models/create_cluster_details.rb', line 161

def to_s
  to_hash.to_s
end