Class: OCI::Core::Models::CreateDedicatedVmHostDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/create_dedicated_vm_host_details.rb

Overview

The details for creating a new dedicated virtual machine host.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDedicatedVmHostDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

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

  self.capacity_config = attributes[:'capacityConfig'] if attributes[:'capacityConfig']

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

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

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

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

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain of the dedicated virtual machine host.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 17

def availability_domain
  @availability_domain
end

#capacity_config ⇒ String

The capacity configuration selected to be configured for the Dedicated Virtual Machine host. Run list_dedicated_vm_host_shapes API first to see the capacity configuration options.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 71

def capacity_config
  @capacity_config
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 21

def compartment_id
  @compartment_id
end

#dedicated_vm_host_shape ⇒ String

[Required] The dedicated virtual machine host shape. The shape determines the number of CPUs and other resources available for VM instances launched on the dedicated virtual machine host.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 27

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


35
36
37
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 35

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 41

def display_name
  @display_name
end

#fault_domain ⇒ String

The fault domain for the dedicated virtual machine host's assigned instances. For more information, see Fault Domains. If you do not specify the fault domain, the system selects one for you. To change the fault domain for a dedicated virtual machine host, delete it and create a new dedicated virtual machine host in the preferred fault domain.

To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 54

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


62
63
64
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 62

def freeform_tags
  @freeform_tags
end

#is_memory_encryption_enabled ⇒ BOOLEAN

Specifies if the Dedicated Virtual Machine Host (DVMH) is restricted to running only Confidential VMs. If true, only Confidential VMs can be launched. If false, Confidential VMs cannot be launched.

Returns:

  • (BOOLEAN) 


76
77
78
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 76

def is_memory_encryption_enabled
  @is_memory_encryption_enabled
end

#placement_constraint_details ⇒ OCI::Core::Models::PlacementConstraintDetails

Returns:



65
66
67
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 65

def placement_constraint_details
  @placement_constraint_details
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 79

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compartment_id': :'compartmentId',
    'dedicated_vm_host_shape': :'dedicatedVmHostShape',
    'defined_tags': :'definedTags',
    'display_name': :'displayName',
    'fault_domain': :'faultDomain',
    'freeform_tags': :'freeformTags',
    'placement_constraint_details': :'placementConstraintDetails',
    'capacity_config': :'capacityConfig',
    'is_memory_encryption_enabled': :'isMemoryEncryptionEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compartment_id': :'String',
    'dedicated_vm_host_shape': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'display_name': :'String',
    'fault_domain': :'String',
    'freeform_tags': :'Hash<String, String>',
    'placement_constraint_details': :'OCI::Core::Models::PlacementConstraintDetails',
    'capacity_config': :'String',
    'is_memory_encryption_enabled': :'BOOLEAN'
    # 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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 206

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compartment_id == other.compartment_id &&
    dedicated_vm_host_shape == other.dedicated_vm_host_shape &&
    defined_tags == other.defined_tags &&
    display_name == other.display_name &&
    fault_domain == other.fault_domain &&
    freeform_tags == other.freeform_tags &&
    placement_constraint_details == other.placement_constraint_details &&
    capacity_config == other.capacity_config &&
    is_memory_encryption_enabled == other.is_memory_encryption_enabled
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 245

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


225
226
227
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 234

def hash
  [availability_domain, compartment_id, dedicated_vm_host_shape, defined_tags, display_name, fault_domain, freeform_tags, placement_constraint_details, capacity_config, is_memory_encryption_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 278

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



272
273
274
 
# File 'lib/oci/core/models/create_dedicated_vm_host_details.rb', line 272

def to_s
  to_hash.to_s
end