Class: OCI::Ocvp::Models::CreateEsxiHostDetails

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

Overview

Details of the ESXi host to add to the Cluster.

Constant Summary collapse

CURRENT_COMMITMENT_ENUM = 
[
  CURRENT_COMMITMENT_HOUR = 'HOUR'.freeze,
  CURRENT_COMMITMENT_MONTH = 'MONTH'.freeze,
  CURRENT_COMMITMENT_ONE_YEAR = 'ONE_YEAR'.freeze,
  CURRENT_COMMITMENT_THREE_YEARS = 'THREE_YEARS'.freeze
].freeze
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 = {}) ⇒ CreateEsxiHostDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :cluster_id (String) —

    The value to assign to the #cluster_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :billing_donor_host_id (String) —

    The value to assign to the #billing_donor_host_id property

  • :current_commitment (String) —

    The value to assign to the #current_commitment property

  • :next_commitment (String) —

    The value to assign to the #next_commitment property

  • :compute_availability_domain (String) —

    The value to assign to the #compute_availability_domain property

  • :host_shape_name (String) —

    The value to assign to the #host_shape_name property

  • :host_ocpu_count (Float) —

    The value to assign to the #host_ocpu_count property

  • :capacity_reservation_id (String) —

    The value to assign to the #capacity_reservation_id property

  • :esxi_software_version (String) —

    The value to assign to the #esxi_software_version 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



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 167

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.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.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.current_commitment = attributes[:'currentCommitment'] if attributes[:'currentCommitment']
  self.current_commitment = "HOUR" if current_commitment.nil? && !attributes.key?(:'currentCommitment') # rubocop:disable Style/StringLiterals

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

  self.current_commitment = attributes[:'current_commitment'] if attributes[:'current_commitment']
  self.current_commitment = "HOUR" if current_commitment.nil? && !attributes.key?(:'currentCommitment') && !attributes.key?(:'current_commitment') # rubocop:disable Style/StringLiterals

  self.next_commitment = attributes[:'nextCommitment'] if attributes[:'nextCommitment']
  self.next_commitment = "HOUR" if next_commitment.nil? && !attributes.key?(:'nextCommitment') # rubocop:disable Style/StringLiterals

  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.next_commitment = "HOUR" if next_commitment.nil? && !attributes.key?(:'nextCommitment') && !attributes.key?(:'next_commitment') # rubocop:disable Style/StringLiterals

  self.compute_availability_domain = attributes[:'computeAvailabilityDomain'] if attributes[:'computeAvailabilityDomain']

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

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

  self.host_shape_name = attributes[:'hostShapeName'] if attributes[:'hostShapeName']

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

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

  self.host_ocpu_count = attributes[:'hostOcpuCount'] if attributes[:'hostOcpuCount']

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

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

  self.capacity_reservation_id = attributes[:'capacityReservationId'] if attributes[:'capacityReservationId']

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

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

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

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 47

def billing_donor_host_id
  @billing_donor_host_id
end

#capacity_reservation_id ⇒ String

The OCID of the Capacity Reservation.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 83

def capacity_reservation_id
  @capacity_reservation_id
end

#cluster_id ⇒ String

[Required] The OCID of the Cluster to add the ESXi host to.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 28

def cluster_id
  @cluster_id
end

#compute_availability_domain ⇒ String

The availability domain to create the ESXi host in. If keep empty, for AD-specific Cluster, new ESXi host will be created in the same availability domain; for multi-AD Cluster, new ESXi host will be auto assigned to the next availability domain following evenly distribution strategy.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 67

def compute_availability_domain
  @compute_availability_domain
end

#current_commitment ⇒ String

The billing option currently used by the ESXi host. list_supported_commitments.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 53

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


107
108
109
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 107

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-16 character length limit, Must start with a letter, Must be English letters, numbers, - only, No repeating hyphens, Must be unique within the Cluster.

If this attribute is not specified, the Cluster's instanceDisplayNamePrefix attribute is used to name and incrementally number the ESXi host. For example, if you're creating the fourth ESXi host in the Cluster, and instanceDisplayNamePrefix is MyCluster, the host's display name is MyCluster-4.

Avoid entering confidential information.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 42

def display_name
  @display_name
end

#esxi_software_version ⇒ String

The ESXi software bundle to install on the ESXi host. Only versions under the same vmwareSoftwareVersion and have been validate by Oracle Cloud VMware Solution will be accepted. To get a list of the available versions, use list_supported_vmware_software_versions.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 91

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


99
100
101
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 99

def freeform_tags
  @freeform_tags
end

#host_ocpu_count ⇒ Float

The OCPU count of the ESXi host.

Returns:

  • (Float) 


78
79
80
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 78

def host_ocpu_count
  @host_ocpu_count
end

#host_shape_name ⇒ String

The compute shape name of the ESXi host. list_supported_host_shapes.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 73

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


60
61
62
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 60

def next_commitment
  @next_commitment
end

Class Method Details

.attribute_map ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 110

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cluster_id': :'clusterId',
    'display_name': :'displayName',
    'billing_donor_host_id': :'billingDonorHostId',
    'current_commitment': :'currentCommitment',
    'next_commitment': :'nextCommitment',
    'compute_availability_domain': :'computeAvailabilityDomain',
    'host_shape_name': :'hostShapeName',
    'host_ocpu_count': :'hostOcpuCount',
    'capacity_reservation_id': :'capacityReservationId',
    'esxi_software_version': :'esxiSoftwareVersion',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cluster_id': :'String',
    'display_name': :'String',
    'billing_donor_host_id': :'String',
    'current_commitment': :'String',
    'next_commitment': :'String',
    'compute_availability_domain': :'String',
    'host_shape_name': :'String',
    'host_ocpu_count': :'Float',
    'capacity_reservation_id': :'String',
    'esxi_software_version': :'String',
    '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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 273

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

  self.class == other.class &&
    cluster_id == other.cluster_id &&
    display_name == other.display_name &&
    billing_donor_host_id == other.billing_donor_host_id &&
    current_commitment == other.current_commitment &&
    next_commitment == other.next_commitment &&
    compute_availability_domain == other.compute_availability_domain &&
    host_shape_name == other.host_shape_name &&
    host_ocpu_count == other.host_ocpu_count &&
    capacity_reservation_id == other.capacity_reservation_id &&
    esxi_software_version == other.esxi_software_version &&
    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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 314

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


294
295
296
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 294

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



303
304
305
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 303

def hash
  [cluster_id, display_name, billing_donor_host_id, current_commitment, next_commitment, compute_availability_domain, host_shape_name, host_ocpu_count, capacity_reservation_id, esxi_software_version, 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



347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 347

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



341
342
343
 
# File 'lib/oci/ocvp/models/create_esxi_host_details.rb', line 341

def to_s
  to_hash.to_s
end