Class: OCI::Dns::Models::CreateResolverVnicEndpointDetails

Inherits:
CreateResolverEndpointDetails show all
Defined in:
lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb

Overview

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.

Constant Summary

Constants inherited from CreateResolverEndpointDetails

OCI::Dns::Models::CreateResolverEndpointDetails::ENDPOINT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateResolverEndpointDetails

#defined_tags, #endpoint_type, #forwarding_address, #freeform_tags, #is_forwarding, #is_listening, #listening_address, #name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateResolverEndpointDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateResolverVnicEndpointDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name proprety

  • :forwarding_address (String) —

    The value to assign to the #forwarding_address proprety

  • :is_forwarding (BOOLEAN) —

    The value to assign to the #is_forwarding proprety

  • :is_listening (BOOLEAN) —

    The value to assign to the #is_listening proprety

  • :listening_address (String) —

    The value to assign to the #listening_address proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes property



84
85
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
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 84

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

  self.security_attributes = attributes[:'securityAttributes'] if attributes[:'securityAttributes']

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

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

Instance Attribute Details

#nsg_ids ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


25
26
27
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 25

def nsg_ids
  @nsg_ids
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Returns:

  • (Hash<String, Hash<String, Object>>) 


28
29
30
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 28

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 19

def subnet_id
  @subnet_id
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 31

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 50

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',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'security_attributes': :'Hash<String, Hash<String, Object>>'
    # 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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 120

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    security_attributes == other.security_attributes
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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 160

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


140
141
142
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 149

def hash
  [name, endpoint_type, forwarding_address, is_forwarding, is_listening, listening_address, freeform_tags, defined_tags, subnet_id, nsg_ids, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 193

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



187
188
189
 
# File 'lib/oci/dns/models/create_resolver_vnic_endpoint_details.rb', line 187

def to_s
  to_hash.to_s
end