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



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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 95

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

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

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

  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

#compute_cluster_id ⇒ String

The OCID of the compute cluster that the instance will be created in.

Returns:

  • (String) 


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

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


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

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) 


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

def primary_subnet_id
  @primary_subnet_id
end

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

Returns:



49
50
51
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 49

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:



53
54
55
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 53

def secondary_vnic_subnets
  @secondary_vnic_subnets
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'availabilityDomain',
    'compute_cluster_id': :'computeClusterId',
    '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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'availability_domain': :'String',
    'compute_cluster_id': :'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



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 145

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

  self.class == other.class &&
    availability_domain == other.availability_domain &&
    compute_cluster_id == other.compute_cluster_id &&
    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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 180

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


160
161
162
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



169
170
171
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 169

def hash
  [availability_domain, compute_cluster_id, 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



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 213

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



207
208
209
 
# File 'lib/oci/core/models/instance_pool_placement_configuration.rb', line 207

def to_s
  to_hash.to_s
end