class OCI::Dns::Models::CreateResolverVnicEndpointDetails

The body for defining a new resolver VNIC endpoint. Either isForwarding or isListening must be true, but not both. If isListening is true, a listeningAddress may be provided. If isForwarding is true, a forwardingAddress may be provided. When not provided, an address will be chosen automatically.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

nsg_ids[RW]

An array of network security group OCIDs for the resolver endpoint. These must be part of the VCN that the resolver endpoint is a part of.

@return [Array<String>]

subnet_id[RW]

[Required] The OCID of a subnet. Must be part of the VCN that the resolver is attached to. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 27
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'endpoint_type': :'endpointType',
    'forwarding_address': :'forwardingAddress',
    'is_forwarding': :'isForwarding',
    'is_listening': :'isListening',
    'listening_address': :'listeningAddress',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {OCI::Dns::Models::CreateResolverEndpointDetails#name name} proprety @option attributes [String] :forwarding_address The value to assign to the {OCI::Dns::Models::CreateResolverEndpointDetails#forwarding_address forwarding_address} proprety @option attributes [BOOLEAN] :is_forwarding The value to assign to the {OCI::Dns::Models::CreateResolverEndpointDetails#is_forwarding is_forwarding} proprety @option attributes [BOOLEAN] :is_listening The value to assign to the {OCI::Dns::Models::CreateResolverEndpointDetails#is_listening is_listening} proprety @option attributes [String] :listening_address The value to assign to the {OCI::Dns::Models::CreateResolverEndpointDetails#listening_address listening_address} proprety @option attributes [String] :subnet_id The value to assign to the {#subnet_id} property @option attributes [Array<String>] :nsg_ids The value to assign to the {#nsg_ids} property

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 71
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['endpointType'] = 'VNIC'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  self.nsg_ids = attributes[:'nsgIds'] if attributes[:'nsgIds']

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

  self.nsg_ids = attributes[:'nsg_ids'] if attributes[:'nsg_ids']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 43
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'endpoint_type': :'String',
    'forwarding_address': :'String',
    'is_forwarding': :'BOOLEAN',
    'is_listening': :'BOOLEAN',
    'listening_address': :'String',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 101
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    endpoint_type == other.endpoint_type &&
    forwarding_address == other.forwarding_address &&
    is_forwarding == other.is_forwarding &&
    is_listening == other.is_listening &&
    listening_address == other.listening_address &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 138
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 118
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 127
def hash
  [name, endpoint_type, forwarding_address, is_forwarding, is_listening, listening_address, subnet_id, nsg_ids].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 171
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 165
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb, line 188
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end