Class: OCI::Dns::Models::Resolver

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

Overview

An OCI DNS resolver. If the resolver has an attached VCN, the VCN will attempt to answer queries based on the attached views in priority order. If the query does not match any of the attached views, the query will be evaluated against the default view. If the default view does not match, the rules will be evaluated in priority order. If no rules match the query, answers come from Internet DNS. A resolver may have a maximum of 10 resolver endpoints.

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

Constant Summary collapse

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 = {}) ⇒ Resolver

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



180
181
182
183
184
185
186
187
188
189
190
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
# File 'lib/oci/dns/models/resolver.rb', line 180

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

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

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

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

  self.id = attributes[:'id'] if attributes[:'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.default_view_id = attributes[:'defaultViewId'] if attributes[:'defaultViewId']

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

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

  self.is_protected = attributes[:'isProtected'] unless attributes[:'isProtected'].nil?

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

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

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

  self.attached_views = attributes[:'attachedViews'] if attributes[:'attachedViews']

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

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

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

Instance Attribute Details

#_selfString

[Required] The canonical absolute URL of the resource.

Returns:

  • (String)


87
88
89
# File 'lib/oci/dns/models/resolver.rb', line 87

def _self
  @_self
end

#attached_vcn_idString

The OCID of the attached VCN.

Returns:

  • (String)


36
37
38
# File 'lib/oci/dns/models/resolver.rb', line 36

def attached_vcn_id
  @attached_vcn_id
end

#attached_viewsArray<OCI::Dns::Models::AttachedView>

[Required] The attached views. Views are evaluated in order.

Returns:



106
107
108
# File 'lib/oci/dns/models/resolver.rb', line 106

def attached_views
  @attached_views
end

#compartment_idString

[Required] The OCID of the owning compartment.

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#default_view_idString

The OCID of the default view.

Returns:

  • (String)


92
93
94
# File 'lib/oci/dns/models/resolver.rb', line 92

def default_view_id
  @default_view_id
end

#defined_tagsHash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


59
60
61
# File 'lib/oci/dns/models/resolver.rb', line 59

def defined_tags
  @defined_tags
end

#display_nameString

[Required] The display name of the resolver.

Returns:

  • (String)


41
42
43
# File 'lib/oci/dns/models/resolver.rb', line 41

def display_name
  @display_name
end

#endpointsArray<OCI::Dns::Models::ResolverEndpointSummary>

[Required] Read-only array of endpoints for the resolver.



102
103
104
# File 'lib/oci/dns/models/resolver.rb', line 102

def endpoints
  @endpoints
end

#freeform_tagsHash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


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

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the resolver.

Returns:

  • (String)


63
64
65
# File 'lib/oci/dns/models/resolver.rb', line 63

def id
  @id
end

#is_protectedBOOLEAN

[Required] A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.

Returns:

  • (BOOLEAN)


97
98
99
# File 'lib/oci/dns/models/resolver.rb', line 97

def is_protected
  @is_protected
end

#lifecycle_stateString

[Required] The current state of the resource.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#rulesArray<OCI::Dns::Models::ResolverRule>

Rules for the resolver. Rules are evaluated in order.

Returns:



111
112
113
# File 'lib/oci/dns/models/resolver.rb', line 111

def rules
  @rules
end

#time_createdDateTime

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


71
72
73
# File 'lib/oci/dns/models/resolver.rb', line 71

def time_created
  @time_created
end

#time_updatedDateTime

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


79
80
81
# File 'lib/oci/dns/models/resolver.rb', line 79

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/oci/dns/models/resolver.rb', line 114

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'attached_vcn_id': :'attachedVcnId',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'id': :'id',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    '_self': :'self',
    'default_view_id': :'defaultViewId',
    'is_protected': :'isProtected',
    'endpoints': :'endpoints',
    'attached_views': :'attachedViews',
    'rules': :'rules'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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.rb', line 137

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'attached_vcn_id': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    '_self': :'String',
    'default_view_id': :'String',
    'is_protected': :'BOOLEAN',
    'endpoints': :'Array<OCI::Dns::Models::ResolverEndpointSummary>',
    'attached_views': :'Array<OCI::Dns::Models::AttachedView>',
    'rules': :'Array<OCI::Dns::Models::ResolverRule>'
    # 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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/oci/dns/models/resolver.rb', line 285

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    attached_vcn_id == other.attached_vcn_id &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    id == other.id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    _self == other._self &&
    default_view_id == other.default_view_id &&
    is_protected == other.is_protected &&
    endpoints == other.endpoints &&
    attached_views == other.attached_views &&
    rules == other.rules
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/oci/dns/models/resolver.rb', line 329

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


309
310
311
# File 'lib/oci/dns/models/resolver.rb', line 309

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



318
319
320
# File 'lib/oci/dns/models/resolver.rb', line 318

def hash
  [compartment_id, attached_vcn_id, display_name, freeform_tags, defined_tags, id, time_created, time_updated, lifecycle_state, _self, default_view_id, is_protected, endpoints, attached_views, rules].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



362
363
364
365
366
367
368
369
370
371
# File 'lib/oci/dns/models/resolver.rb', line 362

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



356
357
358
# File 'lib/oci/dns/models/resolver.rb', line 356

def to_s
  to_hash.to_s
end