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



86
87
88
89
90
91
92
93
94
95
96
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
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 86

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

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

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

  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_domain ⇒ String

[Required] The availability domain to place instances.

Example: Uocm:PHX-AD-1

Returns:

  • (String) 


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

def availability_domain
  @availability_domain
end

#fault_domains ⇒ Array<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>) 


40
41
42
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 40

def fault_domains
  @fault_domains
end

#primary_subnet_id ⇒ String

The OCID of the primary subnet in which to place instances. This field is deprecated. Use primaryVnicSubnets instead to set VNIC data for instances in the pool.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 22

def primary_subnet_id
  @primary_subnet_id
end

#primary_vnic_subnets ⇒ OCI::Core::Models::InstancePoolPlacementPrimarySubnet

Returns:



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

def primary_vnic_subnets
  @primary_vnic_subnets
end

#secondary_vnic_subnets ⇒ Array<OCI::Core::Models::InstancePoolPlacementSecondaryVnicSubnet>

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

Returns:



47
48
49
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 47

def secondary_vnic_subnets
  @secondary_vnic_subnets
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 50

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

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 63

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



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 130

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 &&
    primary_vnic_subnets == other.primary_vnic_subnets &&
    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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 164

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


144
145
146
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



153
154
155
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 153

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 197

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



191
192
193
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 191

def to_s
  to_hash.to_s
end