Class: OCI::Ocvp::Models::CreateClusterDetails

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

Overview

Details of the Cluster.

Constant Summary collapse

INITIAL_COMMITMENT_ENUM = 
[
  INITIAL_COMMITMENT_HOUR = 'HOUR'.freeze,
  INITIAL_COMMITMENT_MONTH = 'MONTH'.freeze,
  INITIAL_COMMITMENT_ONE_YEAR = 'ONE_YEAR'.freeze,
  INITIAL_COMMITMENT_THREE_YEARS = 'THREE_YEARS'.freeze
].freeze

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



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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 202

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

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

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

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

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

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

  self.esxi_hosts_count = attributes[:'esxiHostsCount'] if attributes[:'esxiHostsCount']

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

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

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

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

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

  self.workload_network_cidr = attributes[:'workloadNetworkCidr'] if attributes[:'workloadNetworkCidr']

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

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

  self.initial_host_shape_name = attributes[:'initialHostShapeName'] if attributes[:'initialHostShapeName']
  self.initial_host_shape_name = "BM.DenseIO2.52" if initial_host_shape_name.nil? && !attributes.key?(:'initialHostShapeName') # rubocop:disable Style/StringLiterals

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

  self.initial_host_shape_name = attributes[:'initial_host_shape_name'] if attributes[:'initial_host_shape_name']
  self.initial_host_shape_name = "BM.DenseIO2.52" if initial_host_shape_name.nil? && !attributes.key?(:'initialHostShapeName') && !attributes.key?(:'initial_host_shape_name') # rubocop:disable Style/StringLiterals

  self.initial_host_ocpu_count = attributes[:'initialHostOcpuCount'] if attributes[:'initialHostOcpuCount']

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

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

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

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

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

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

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

#capacity_reservation_id ⇒ String

The OCID of the Capacity Reservation.

Returns:

  • (String) 


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

def capacity_reservation_id
  @capacity_reservation_id
end

#compute_availability_domain ⇒ String

[Required] The availability domain to create the Cluster's ESXi hosts in. For multi-AD Cluster deployment, set to multi-AD.

Returns:

  • (String) 


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

def compute_availability_domain
  @compute_availability_domain
end

#datastores ⇒ Array<OCI::Ocvp::Models::DatastoreInfo>

A list of datastore info for the Cluster. This value is required only when initialHostShapeName is a standard shape.

Returns:



97
98
99
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 97

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


127
128
129
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 127

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A descriptive name for the Cluster. Cluster 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 region. Avoid entering confidential information.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 34

def display_name
  @display_name
end

#esxi_hosts_count ⇒ Integer

[Required] The number of ESXi hosts to create in the Cluster. You can add more hosts later (see create_esxi_host).

Note: If you later delete EXSi hosts from a production Cluster to make SDDC total host count less than 3, you are still billed for the 3 minimum recommended ESXi hosts. Also, you cannot add more VMware workloads to the Cluster until the SDDC again has at least 3 ESXi hosts.

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 54

def esxi_hosts_count
  @esxi_hosts_count
end

#esxi_software_version ⇒ String

The ESXi software bundle to install on the ESXi hosts in the Cluster. 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) 


111
112
113
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 111

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


119
120
121
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 119

def freeform_tags
  @freeform_tags
end

#initial_commitment ⇒ String

The billing option selected during Cluster creation. list_supported_commitments.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 64

def initial_commitment
  @initial_commitment
end

#initial_host_ocpu_count ⇒ Float

The initial OCPU count of the Cluster's ESXi hosts.

Returns:

  • (Float) 


81
82
83
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 81

def initial_host_ocpu_count
  @initial_host_ocpu_count
end

#initial_host_shape_name ⇒ String

The initial compute shape of the Cluster's ESXi hosts. list_supported_host_shapes.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 76

def initial_host_shape_name
  @initial_host_shape_name
end

#instance_display_name_prefix ⇒ String

A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.

For example, if the value is myCluster, the ESXi hosts are named myCluster-1, myCluster-2, and so on.

Returns:

  • (String) 


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

def instance_display_name_prefix
  @instance_display_name_prefix
end

#is_shielded_instance_enabled ⇒ BOOLEAN

Indicates whether shielded instance is enabled for this Cluster.

Returns:

  • (BOOLEAN) 


86
87
88
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 86

def is_shielded_instance_enabled
  @is_shielded_instance_enabled
end

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

This attribute is required.

Returns:



58
59
60
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 58

def network_configuration
  @network_configuration
end

#sddc_id ⇒ String

[Required] The OCID of the SDDC that the Cluster belongs to.

Returns:

  • (String) 


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

def sddc_id
  @sddc_id
end

#vmware_software_version ⇒ String

The VMware software bundle to install on the ESXi hosts in the Cluster. To get a list of the available versions, use list_supported_vmware_software_versions.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 103

def vmware_software_version
  @vmware_software_version
end

#workload_network_cidr ⇒ String

The CIDR block for the IP addresses that VMware VMs in the Cluster use to run application workloads.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 70

def workload_network_cidr
  @workload_network_cidr
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'sddc_id': :'sddcId',
    'compute_availability_domain': :'computeAvailabilityDomain',
    'display_name': :'displayName',
    'instance_display_name_prefix': :'instanceDisplayNamePrefix',
    'esxi_hosts_count': :'esxiHostsCount',
    'network_configuration': :'networkConfiguration',
    'initial_commitment': :'initialCommitment',
    'workload_network_cidr': :'workloadNetworkCidr',
    'initial_host_shape_name': :'initialHostShapeName',
    'initial_host_ocpu_count': :'initialHostOcpuCount',
    'is_shielded_instance_enabled': :'isShieldedInstanceEnabled',
    'capacity_reservation_id': :'capacityReservationId',
    'datastores': :'datastores',
    'vmware_software_version': :'vmwareSoftwareVersion',
    'esxi_software_version': :'esxiSoftwareVersion',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 155

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'sddc_id': :'String',
    'compute_availability_domain': :'String',
    'display_name': :'String',
    'instance_display_name_prefix': :'String',
    'esxi_hosts_count': :'Integer',
    'network_configuration': :'OCI::Ocvp::Models::NetworkConfiguration',
    'initial_commitment': :'String',
    'workload_network_cidr': :'String',
    'initial_host_shape_name': :'String',
    'initial_host_ocpu_count': :'Float',
    'is_shielded_instance_enabled': :'BOOLEAN',
    'capacity_reservation_id': :'String',
    'datastores': :'Array<OCI::Ocvp::Models::DatastoreInfo>',
    'vmware_software_version': :'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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 328

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

  self.class == other.class &&
    sddc_id == other.sddc_id &&
    compute_availability_domain == other.compute_availability_domain &&
    display_name == other.display_name &&
    instance_display_name_prefix == other.instance_display_name_prefix &&
    esxi_hosts_count == other.esxi_hosts_count &&
    network_configuration == other.network_configuration &&
    initial_commitment == other.initial_commitment &&
    workload_network_cidr == other.workload_network_cidr &&
    initial_host_shape_name == other.initial_host_shape_name &&
    initial_host_ocpu_count == other.initial_host_ocpu_count &&
    is_shielded_instance_enabled == other.is_shielded_instance_enabled &&
    capacity_reservation_id == other.capacity_reservation_id &&
    datastores == other.datastores &&
    vmware_software_version == other.vmware_software_version &&
    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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 374

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


354
355
356
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 354

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



363
364
365
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 363

def hash
  [sddc_id, compute_availability_domain, display_name, instance_display_name_prefix, esxi_hosts_count, network_configuration, initial_commitment, workload_network_cidr, initial_host_shape_name, initial_host_ocpu_count, is_shielded_instance_enabled, capacity_reservation_id, datastores, vmware_software_version, 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



407
408
409
410
411
412
413
414
415
416
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 407

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



401
402
403
 
# File 'lib/oci/ocvp/models/create_cluster_details.rb', line 401

def to_s
  to_hash.to_s
end