Class: OCI::Core::Models::CreateComputeHostGroupDetails

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

Overview

Detail information for a compute host group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateComputeHostGroupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



97
98
99
100
101
102
103
104
105
106
107
108
109
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
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 97

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

  self.is_targeted_placement_required = attributes[:'isTargetedPlacementRequired'] unless attributes[:'isTargetedPlacementRequired'].nil?

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

  self.is_targeted_placement_required = attributes[:'is_targeted_placement_required'] unless attributes[:'is_targeted_placement_required'].nil?

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain of a host group.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


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

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains host group.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 28

def compartment_id
  @compartment_id
end

#configurations ⇒ Array<OCI::Core::Models::HostGroupConfiguration>

A list of HostGroupConfiguration objects

Returns:



32
33
34
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 32

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


44
45
46
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 44

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 23

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


52
53
54
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 52

def freeform_tags
  @freeform_tags
end

#is_targeted_placement_required ⇒ BOOLEAN

[Required] A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group.

Returns:

  • (BOOLEAN) 


36
37
38
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 36

def is_targeted_placement_required
  @is_targeted_placement_required
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'configurations': :'configurations',
    'is_targeted_placement_required': :'isTargetedPlacementRequired',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'configurations': :'Array<OCI::Core::Models::HostGroupConfiguration>',
    'is_targeted_placement_required': :'BOOLEAN',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>'
    # 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



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 149

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    configurations == other.configurations &&
    is_targeted_placement_required == other.is_targeted_placement_required &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 185

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


165
166
167
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 165

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



174
175
176
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 174

def hash
  [availability_domain, display_name, compartment_id, configurations, is_targeted_placement_required, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 218

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



212
213
214
 
# File 'lib/oci/core/models/create_compute_host_group_details.rb', line 212

def to_s
  to_hash.to_s
end