Class: OCI::Ocvp::Models::CreateSddcDetails

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

Overview

Details of the SDDC.

Constant Summary collapse

HCX_MODE_ENUM =
[
  HCX_MODE_DISABLED = 'DISABLED'.freeze,
  HCX_MODE_ADVANCED = 'ADVANCED'.freeze,
  HCX_MODE_ENTERPRISE = 'ENTERPRISE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSddcDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
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
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 138

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

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

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

  self.initial_configuration = attributes[:'initialConfiguration'] if attributes[:'initialConfiguration']

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

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

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

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

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

  self.ssh_authorized_keys = attributes[:'sshAuthorizedKeys'] if attributes[:'sshAuthorizedKeys']

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

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

  self.sddc_byol_allocation_details = attributes[:'sddcByolAllocationDetails'] if attributes[:'sddcByolAllocationDetails']

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

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

#compartment_idString

[Required] The OCID of the compartment to contain the SDDC.

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

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


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

def defined_tags
  @defined_tags
end

#display_nameString

A descriptive name for the SDDC. SDDC 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)


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

def display_name
  @display_name
end

#esxi_software_versionString

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


37
38
39
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 37

def esxi_software_version
  @esxi_software_version
end

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


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

def freeform_tags
  @freeform_tags
end

#hcx_modeString

[Required] HCX configuration of the SDDC.

Returns:

  • (String)


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

def hcx_mode
  @hcx_mode
end

#initial_configurationOCI::Ocvp::Models::InitialConfiguration

This attribute is required.



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

def initial_configuration
  @initial_configuration
end

#is_single_host_sddcBOOLEAN

Indicates whether this SDDC is designated for only single ESXi host.

Returns:

  • (BOOLEAN)


55
56
57
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 55

def is_single_host_sddc
  @is_single_host_sddc
end

#sddc_byol_allocation_detailsOCI::Ocvp::Models::SddcByolAllocationDetails



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

def sddc_byol_allocation_details
  @sddc_byol_allocation_details
end

#ssh_authorized_keysString

[Required] One or more public SSH keys to be included in the ~/.ssh/authorized_keys file for the default user on each ESXi host. Use a newline character to separate multiple keys. The SSH keys must be in the format required for the authorized_keys file

Returns:

  • (String)


62
63
64
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 62

def ssh_authorized_keys
  @ssh_authorized_keys
end

#vmware_software_versionString

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

Returns:

  • (String)


29
30
31
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 29

def vmware_software_version
  @vmware_software_version
end

Class Method Details

.attribute_mapObject

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 84

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'vmware_software_version': :'vmwareSoftwareVersion',
    'esxi_software_version': :'esxiSoftwareVersion',
    'compartment_id': :'compartmentId',
    'hcx_mode': :'hcxMode',
    'initial_configuration': :'initialConfiguration',
    'is_single_host_sddc': :'isSingleHostSddc',
    'ssh_authorized_keys': :'sshAuthorizedKeys',
    'sddc_byol_allocation_details': :'sddcByolAllocationDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 103

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'vmware_software_version': :'String',
    'esxi_software_version': :'String',
    'compartment_id': :'String',
    'hcx_mode': :'String',
    'initial_configuration': :'OCI::Ocvp::Models::InitialConfiguration',
    'is_single_host_sddc': :'BOOLEAN',
    'ssh_authorized_keys': :'String',
    'sddc_byol_allocation_details': :'OCI::Ocvp::Models::SddcByolAllocationDetails',
    '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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 228

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

  self.class == other.class &&
    display_name == other.display_name &&
    vmware_software_version == other.vmware_software_version &&
    esxi_software_version == other.esxi_software_version &&
    compartment_id == other.compartment_id &&
    hcx_mode == other.hcx_mode &&
    initial_configuration == other.initial_configuration &&
    is_single_host_sddc == other.is_single_host_sddc &&
    ssh_authorized_keys == other.ssh_authorized_keys &&
    sddc_byol_allocation_details == other.sddc_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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 268

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


248
249
250
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 248

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



257
258
259
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 257

def hash
  [display_name, vmware_software_version, esxi_software_version, compartment_id, hcx_mode, initial_configuration, is_single_host_sddc, ssh_authorized_keys, sddc_byol_allocation_details, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



301
302
303
304
305
306
307
308
309
310
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 301

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



295
296
297
# File 'lib/oci/ocvp/models/create_sddc_details.rb', line 295

def to_s
  to_hash.to_s
end