Class: OCI::Ocvp::Models::UpdateEsxiHostDetails

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

Overview

The ESXi host information to be updated.

Constant Summary collapse

NEXT_COMMITMENT_ENUM = 
[
  NEXT_COMMITMENT_HOUR = 'HOUR'.freeze,
  NEXT_COMMITMENT_MONTH = 'MONTH'.freeze,
  NEXT_COMMITMENT_ONE_YEAR = 'ONE_YEAR'.freeze,
  NEXT_COMMITMENT_THREE_YEARS = 'THREE_YEARS'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateEsxiHostDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :next_commitment (String) —

    The value to assign to the #next_commitment property

  • :billing_donor_host_id (String) —

    The value to assign to the #billing_donor_host_id property

  • :vcf_byol_allocation_id (String) —

    The value to assign to the #vcf_byol_allocation_id property

  • :is_vsan_byol_enabled (BOOLEAN) —

    The value to assign to the #is_vsan_byol_enabled property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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
152
153
154
155
156
157
158
159
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 110

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

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

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

  self.billing_donor_host_id = attributes[:'billingDonorHostId'] if attributes[:'billingDonorHostId']

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

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

  self.vcf_byol_allocation_id = attributes[:'vcfByolAllocationId'] if attributes[:'vcfByolAllocationId']

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

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

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

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

  self.is_vsan_byol_enabled = attributes[:'is_vsan_byol_enabled'] unless attributes[:'is_vsan_byol_enabled'].nil?
  self.is_vsan_byol_enabled = false if is_vsan_byol_enabled.nil? && !attributes.key?(:'isVsanByolEnabled') && !attributes.key?(:'is_vsan_byol_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']
end

Instance Attribute Details

#billing_donor_host_id ⇒ String

The OCID of the deleted ESXi Host with leftover billing cycle.

Note: This option also requires the nextCommitment parameter to be populated with a value other than HOUR. Otherwise, any update request fails with the error u201CNext SKU canu2019t be NULL or Hourly.u201D

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 39

def billing_donor_host_id
  @billing_donor_host_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>>) 


65
66
67
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 65

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A descriptive name for the ESXi host. It's changeable. Esxi Host name requirements are 1-25 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the Cluster.

Avoid entering confidential information.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 24

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>) 


57
58
59
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 57

def freeform_tags
  @freeform_tags
end

#is_vsan_byol_enabled ⇒ BOOLEAN

Indicates whether this host embedded VMware vSAN with BYOL Allocation.

Returns:

  • (BOOLEAN) 


49
50
51
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 49

def is_vsan_byol_enabled
  @is_vsan_byol_enabled
end

#next_commitment ⇒ String

The billing option to switch to after the existing billing cycle ends. If nextCommitment is null or empty, currentCommitment continues to the next billing cycle. list_supported_commitments.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 31

def next_commitment
  @next_commitment
end

#vcf_byol_allocation_id ⇒ String

The OCID of the Byol Allocation for VCF (VMware Cloud Foundation) deployment.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 44

def vcf_byol_allocation_id
  @vcf_byol_allocation_id
end

Class Method Details

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 68

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'next_commitment': :'nextCommitment',
    'billing_donor_host_id': :'billingDonorHostId',
    'vcf_byol_allocation_id': :'vcfByolAllocationId',
    'is_vsan_byol_enabled': :'isVsanByolEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 83

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'next_commitment': :'String',
    'billing_donor_host_id': :'String',
    'vcf_byol_allocation_id': :'String',
    'is_vsan_byol_enabled': :'BOOLEAN',
    '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



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 176

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

  self.class == other.class &&
    display_name == other.display_name &&
    next_commitment == other.next_commitment &&
    billing_donor_host_id == other.billing_donor_host_id &&
    vcf_byol_allocation_id == other.vcf_byol_allocation_id &&
    is_vsan_byol_enabled == other.is_vsan_byol_enabled &&
    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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 212

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


192
193
194
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 192

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



201
202
203
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 201

def hash
  [display_name, next_commitment, billing_donor_host_id, vcf_byol_allocation_id, is_vsan_byol_enabled, 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



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 245

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



239
240
241
 
# File 'lib/oci/ocvp/models/update_esxi_host_details.rb', line 239

def to_s
  to_hash.to_s
end