Class: OCI::Dns::Models::ResolverEndpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dns/models/resolver_endpoint.rb

Overview

An OCI DNS resolver endpoint.

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

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

ResolverVnicEndpoint

Constant Summary collapse

ENDPOINT_TYPE_ENUM = 
[
  ENDPOINT_TYPE_VNIC = 'VNIC'.freeze,
  ENDPOINT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResolverEndpoint

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 property

  • :endpoint_type (String) —

    The value to assign to the #endpoint_type property

  • :forwarding_address (String) —

    The value to assign to the #forwarding_address property

  • :is_forwarding (BOOLEAN) —

    The value to assign to the #is_forwarding property

  • :is_listening (BOOLEAN) —

    The value to assign to the #is_listening property

  • :listening_address (String) —

    The value to assign to the #listening_address property

  • :id (String) —

    The value to assign to the #id property

  • :resolver_id (String) —

    The value to assign to the #resolver_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :_self (String) —

    The value to assign to the #_self property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 191

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

  self.endpoint_type = attributes[:'endpointType'] if attributes[:'endpointType']
  self.endpoint_type = "VNIC" if endpoint_type.nil? && !attributes.key?(:'endpointType') # rubocop:disable Style/StringLiterals

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

  self.endpoint_type = attributes[:'endpoint_type'] if attributes[:'endpoint_type']
  self.endpoint_type = "VNIC" if endpoint_type.nil? && !attributes.key?(:'endpointType') && !attributes.key?(:'endpoint_type') # rubocop:disable Style/StringLiterals

  self.forwarding_address = attributes[:'forwardingAddress'] if attributes[:'forwardingAddress']

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

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

  self.is_forwarding = attributes[:'isForwarding'] unless attributes[:'isForwarding'].nil?

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

  self.is_forwarding = attributes[:'is_forwarding'] unless attributes[:'is_forwarding'].nil?

  self.is_listening = attributes[:'isListening'] unless attributes[:'isListening'].nil?

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

  self.is_listening = attributes[:'is_listening'] unless attributes[:'is_listening'].nil?

  self.listening_address = attributes[:'listeningAddress'] if attributes[:'listeningAddress']

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

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

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

  self.resolver_id = attributes[:'resolverId'] if attributes[:'resolverId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#_self ⇒ String

[Required] The canonical absolute URL of the resource.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 99

def _self
  @_self
end

#compartment_id ⇒ String

[Required] The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver's compartment is changed.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 75

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:

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


107
108
109
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 107

def defined_tags
  @defined_tags
end

#endpoint_type ⇒ String

The type of resolver endpoint. VNIC is currently the only supported type.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 39

def endpoint_type
  @endpoint_type
end

#forwarding_address ⇒ String

An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 45

def forwarding_address
  @forwarding_address
end

#freeform_tags ⇒ Hash<String, String>

This attribute is required.

Returns:

  • (Hash<String, String>) 


103
104
105
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 103

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the resolver endpoint.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 65

def id
  @id
end

#is_forwarding ⇒ BOOLEAN

[Required] A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

Returns:

  • (BOOLEAN) 


50
51
52
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 50

def is_forwarding
  @is_forwarding
end

#is_listening ⇒ BOOLEAN

[Required] A Boolean flag indicating whether or not the resolver endpoint is for listening.

Returns:

  • (BOOLEAN) 


55
56
57
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 55

def is_listening
  @is_listening
end

#lifecycle_state ⇒ String

[Required] The current state of the resource.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 95

def lifecycle_state
  @lifecycle_state
end

#listening_address ⇒ String

An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 61

def listening_address
  @listening_address
end

#name ⇒ String

[Required] The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 34

def name
  @name
end

#resolver_id ⇒ String

[Required] The OCID of the resolver.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 69

def resolver_id
  @resolver_id
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

Returns:

  • (DateTime) 


83
84
85
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 83

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the resource was last updated in "YYYY-MM-ddThh:mm:ssZ" format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

Returns:

  • (DateTime) 


91
92
93
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 91

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 110

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



160
161
162
163
164
165
166
167
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 160

def self.get_subtype(object_hash)
  type = object_hash[:'endpointType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Dns::Models::ResolverVnicEndpoint' if type == 'VNIC'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Dns::Models::ResolverEndpoint'
end

.swagger_types ⇒ Object

Attribute type mapping.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 133

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 315

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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 359

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


339
340
341
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 339

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



348
349
350
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 348

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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



392
393
394
395
396
397
398
399
400
401
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 392

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



386
387
388
 
# File 'lib/oci/dns/models/resolver_endpoint.rb', line 386

def to_s
  to_hash.to_s
end