Class: OCI::Core::Models::InstancePoolPlacementConfiguration

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

Overview

The location for where an instance pool will place instances.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstancePoolPlacementConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 78

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

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

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

  self.fault_domains = attributes[:'faultDomains'] if attributes[:'faultDomains']

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

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

  self.secondary_vnic_subnets = attributes[:'secondaryVnicSubnets'] if attributes[:'secondaryVnicSubnets']

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

  self.secondary_vnic_subnets = attributes[:'secondary_vnic_subnets'] if attributes[:'secondary_vnic_subnets']
end

Instance Attribute Details

#availability_domainString

[Required] The availability domain to place instances.

Example: Uocm:PHX-AD-1

Returns:

  • (String)


15
16
17
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 15

def availability_domain
  @availability_domain
end

#fault_domainsArray<String>

The fault domains to place instances.

If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity.

To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability.

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

Example: [FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]

Returns:

  • (Array<String>)


38
39
40
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 38

def fault_domains
  @fault_domains
end

#primary_subnet_idString

[Required] The OCID of the primary subnet to place instances.

Returns:

  • (String)


20
21
22
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 20

def primary_subnet_id
  @primary_subnet_id
end

#secondary_vnic_subnetsArray<OCI::Core::Models::InstancePoolPlacementSecondaryVnicSubnet>

The set of secondary VNIC data for instances in the pool.



42
43
44
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 42

def secondary_vnic_subnets
  @secondary_vnic_subnets
end

Class Method Details

.attribute_mapObject

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



45
46
47
48
49
50
51
52
53
54
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'primary_subnet_id': :'primarySubnetId',
    'fault_domains': :'faultDomains',
    'secondary_vnic_subnets': :'secondaryVnicSubnets'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'primary_subnet_id': :'String',
    'fault_domains': :'Array<String>',
    'secondary_vnic_subnets': :'Array<OCI::Core::Models::InstancePoolPlacementSecondaryVnicSubnet>'
    # 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



116
117
118
119
120
121
122
123
124
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 116

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    primary_subnet_id == other.primary_subnet_id &&
    fault_domains == other.fault_domains &&
    secondary_vnic_subnets == other.secondary_vnic_subnets
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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 149

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


129
130
131
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 129

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



138
139
140
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 138

def hash
  [availability_domain, primary_subnet_id, fault_domains, secondary_vnic_subnets].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



182
183
184
185
186
187
188
189
190
191
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 182

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



176
177
178
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 176

def to_s
  to_hash.to_s
end