Class: OCI::Dns::Models::ResolverVnicEndpoint

Inherits:
ResolverEndpoint show all
Defined in:
lib/oci/dns/models/resolver_vnic_endpoint.rb

Overview

An OCI DNS resolver VNIC endpoint. A VNIC is created for each ResolverVnicEndpoint. VCNs and subnets cannot be deleted while ResolverVnicEndpoints exist in them due to the VNIC.

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

Constant Summary

Constants inherited from ResolverEndpoint

OCI::Dns::Models::ResolverEndpoint::ENDPOINT_TYPE_ENUM, OCI::Dns::Models::ResolverEndpoint::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ResolverEndpoint

#_self, #compartment_id, #defined_tags, #endpoint_type, #forwarding_address, #freeform_tags, #id, #is_forwarding, #is_listening, #lifecycle_state, #listening_address, #name, #resolver_id, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ResolverEndpoint

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ResolverVnicEndpoint

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

  • :id (String) —

    The value to assign to the #id proprety

  • :resolver_id (String) —

    The value to assign to the #resolver_id proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :_self (String) —

    The value to assign to the #self 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

  • :pe_id (String) —

    The value to assign to the #pe_id property

  • :vnic_id (String) —

    The value to assign to the #vnic_id property



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 118

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

  self.pe_id = attributes[:'peId'] if attributes[:'peId']

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

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

  self.vnic_id = attributes[:'vnicId'] if attributes[:'vnicId']

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

  self.vnic_id = attributes[:'vnic_id'] if attributes[:'vnic_id']
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>) 


24
25
26
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 24

def nsg_ids
  @nsg_ids
end

#pe_id ⇒ String

The OCID of the private endpoint resource that this resolver endpoint corresponds to.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 31

def pe_id
  @pe_id
end

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

Returns:

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


27
28
29
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 27

def security_attributes
  @security_attributes
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 18

def subnet_id
  @subnet_id
end

#vnic_id ⇒ String

The OCID of the VNIC resource that this resolver endpoint corresponds to.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 35

def vnic_id
  @vnic_id
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 38

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',
    'id': :'id',
    'resolver_id': :'resolverId',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    '_self': :'self',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'security_attributes': :'securityAttributes',
    'pe_id': :'peId',
    'vnic_id': :'vnicId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 66

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',
    'id': :'String',
    'resolver_id': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    '_self': :'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>>',
    'pe_id': :'String',
    'vnic_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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 166

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 &&
    id == other.id &&
    resolver_id == other.resolver_id &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    _self == other._self &&
    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 &&
    pe_id == other.pe_id &&
    vnic_id == other.vnic_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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 215

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


195
196
197
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 204

def hash
  [name, endpoint_type, forwarding_address, is_forwarding, is_listening, listening_address, id, resolver_id, compartment_id, time_created, time_updated, lifecycle_state, _self, freeform_tags, defined_tags, subnet_id, nsg_ids, security_attributes, pe_id, vnic_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 248

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



242
243
244
 
# File 'lib/oci/dns/models/resolver_vnic_endpoint.rb', line 242

def to_s
  to_hash.to_s
end