Class: OCI::Core::Models::InstancePoolPlacementSecondaryVnicSubnet

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

Overview

The secondary VNIC object for the placement configuration for an instance pool.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstancePoolPlacementSecondaryVnicSubnet

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



72
73
74
75
76
77
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
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 72

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.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.is_assign_ipv6_ip = attributes[:'isAssignIpv6Ip'] unless attributes[:'isAssignIpv6Ip'].nil?
  self.is_assign_ipv6_ip = false if is_assign_ipv6_ip.nil? && !attributes.key?(:'isAssignIpv6Ip') # rubocop:disable Style/StringLiterals

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

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

  self.ipv6_address_ipv6_subnet_cidr_pair_details = attributes[:'ipv6AddressIpv6SubnetCidrPairDetails'] if attributes[:'ipv6AddressIpv6SubnetCidrPairDetails']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

Instance Attribute Details

#display_nameString

The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.

Returns:

  • (String)


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

def display_name
  @display_name
end

#ipv6_address_ipv6_subnet_cidr_pair_detailsArray<OCI::Core::Models::InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails>

A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and OCI will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.



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

def ipv6_address_ipv6_subnet_cidr_pair_details
  @ipv6_address_ipv6_subnet_cidr_pair_details
end

#is_assign_ipv6_ipBOOLEAN

Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.

Returns:

  • (BOOLEAN)


24
25
26
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 24

def is_assign_ipv6_ip
  @is_assign_ipv6_ip
end

#subnet_idString

[Required] The subnet OCID for the secondary VNIC.

Returns:

  • (String)


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

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_mapObject

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



39
40
41
42
43
44
45
46
47
48
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'is_assign_ipv6_ip': :'isAssignIpv6Ip',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'ipv6AddressIpv6SubnetCidrPairDetails',
    'subnet_id': :'subnetId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'is_assign_ipv6_ip': :'BOOLEAN',
    'ipv6_address_ipv6_subnet_cidr_pair_details': :'Array<OCI::Core::Models::InstancePoolPlacementIpv6AddressIpv6SubnetCidrDetails>',
    'subnet_id': :'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



112
113
114
115
116
117
118
119
120
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 112

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

  self.class == other.class &&
    display_name == other.display_name &&
    is_assign_ipv6_ip == other.is_assign_ipv6_ip &&
    ipv6_address_ipv6_subnet_cidr_pair_details == other.ipv6_address_ipv6_subnet_cidr_pair_details &&
    subnet_id == other.subnet_id
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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 145

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


125
126
127
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 125

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



134
135
136
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 134

def hash
  [display_name, is_assign_ipv6_ip, ipv6_address_ipv6_subnet_cidr_pair_details, subnet_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 178

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



172
173
174
# File 'lib/oci/core/models/instance_pool_placement_secondary_vnic_subnet.rb', line 172

def to_s
  to_hash.to_s
end