Class: OCI::Ocvp::Models::UpdateClusterDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/models/update_cluster_details.rb

Overview

The Cluster information to be updated.

Important: Only the displayName, freeFormTags, and definedTags attributes affect the existing Cluster. Changing the other attributes affects the Cluster object, but not the VMware environment currently running on that Cluster. Those other attributes are used by the Oracle Cloud VMware Solution only for new ESXi hosts that you add to this Cluster in the future with create_esxi_host.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



104
105
106
107
108
109
110
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
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 104

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

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

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

  self.vmware_software_version = attributes[:'vmwareSoftwareVersion'] if attributes[:'vmwareSoftwareVersion']

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

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

  self.esxi_software_version = attributes[:'esxiSoftwareVersion'] if attributes[:'esxiSoftwareVersion']

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

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

  self.cluster_byol_allocation_details = attributes[:'clusterByolAllocationDetails'] if attributes[:'clusterByolAllocationDetails']

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

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

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

Instance Attribute Details

#cluster_byol_allocation_details ⇒ OCI::Ocvp::Models::ClusterByolAllocationDetails

Returns:



43
44
45
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 43

def cluster_byol_allocation_details
  @cluster_byol_allocation_details
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/ocvp/models/update_cluster_details.rb', line 59

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The OCID of the Cluster. Cluster name requirements are 1-22 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the region.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 22

def display_name
  @display_name
end

#esxi_software_version ⇒ String

The version of bundled ESXi software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this Cluster in the future unless a specific version is configured on the ESXi level. To get a list of the available versions, use list_supported_vmware_software_versions.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 40

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


51
52
53
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 51

def freeform_tags
  @freeform_tags
end

#network_configuration ⇒ OCI::Ocvp::Models::NetworkConfiguration

Returns:



25
26
27
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 25

def network_configuration
  @network_configuration
end

#vmware_software_version ⇒ String

The version of bundled VMware software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this Cluster in the future. To get a list of the available versions, use list_supported_vmware_software_versions.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 32

def vmware_software_version
  @vmware_software_version
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'network_configuration': :'networkConfiguration',
    'vmware_software_version': :'vmwareSoftwareVersion',
    'esxi_software_version': :'esxiSoftwareVersion',
    'cluster_byol_allocation_details': :'clusterByolAllocationDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'network_configuration': :'OCI::Ocvp::Models::NetworkConfiguration',
    'vmware_software_version': :'String',
    'esxi_software_version': :'String',
    'cluster_byol_allocation_details': :'OCI::Ocvp::Models::ClusterByolAllocationDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 160

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

  self.class == other.class &&
    display_name == other.display_name &&
    network_configuration == other.network_configuration &&
    vmware_software_version == other.vmware_software_version &&
    esxi_software_version == other.esxi_software_version &&
    cluster_byol_allocation_details == other.cluster_byol_allocation_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 196

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


176
177
178
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 176

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 185

def hash
  [display_name, network_configuration, vmware_software_version, esxi_software_version, cluster_byol_allocation_details, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 229

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



223
224
225
 
# File 'lib/oci/ocvp/models/update_cluster_details.rb', line 223

def to_s
  to_hash.to_s
end