Class: OCI::Dns::Models::ZoneSummary

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

Overview

A DNS zone.

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

Constant Summary collapse

ZONE_TYPE_ENUM = 
[
  ZONE_TYPE_PRIMARY = 'PRIMARY'.freeze,
  ZONE_TYPE_SECONDARY = 'SECONDARY'.freeze,
  ZONE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SCOPE_ENUM = 
[
  SCOPE_GLOBAL = 'GLOBAL'.freeze,
  SCOPE_PRIVATE = 'PRIVATE'.freeze,
  SCOPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
RESOLUTION_MODE_ENUM = 
[
  RESOLUTION_MODE_STATIC = 'STATIC'.freeze,
  RESOLUTION_MODE_TRANSPARENT = 'TRANSPARENT'.freeze,
  RESOLUTION_MODE_RTYPE_TRANSPARENT = 'RTYPE_TRANSPARENT'.freeze,
  RESOLUTION_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DNSSEC_STATE_ENUM = 
[
  DNSSEC_STATE_ENABLED = 'ENABLED'.freeze,
  DNSSEC_STATE_DISABLED = 'DISABLED'.freeze,
  DNSSEC_STATE_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 = {}) ⇒ ZoneSummary

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

  • :zone_type (String) —

    The value to assign to the #zone_type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :view_id (String) —

    The value to assign to the #view_id property

  • :scope (String) —

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

  • :resolution_mode (String) —

    The value to assign to the #resolution_mode property

  • :dnssec_state (String) —

    The value to assign to the #dnssec_state property

  • :self_uri (String) —

    The value to assign to the #self_uri property

  • :id (String) —

    The value to assign to the #id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :version (String) —

    The value to assign to the #version property

  • :serial (Integer) —

    The value to assign to the #serial property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :is_protected (BOOLEAN) —

    The value to assign to the #is_protected property

  • :dnssec_config (OCI::Dns::Models::DnssecConfig) —

    The value to assign to the #dnssec_config property



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/oci/dns/models/zone_summary.rb', line 239

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

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

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

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

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

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

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

  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.resolution_mode = attributes[:'resolutionMode'] if attributes[:'resolutionMode']
  self.resolution_mode = "STATIC" if resolution_mode.nil? && !attributes.key?(:'resolutionMode') # rubocop:disable Style/StringLiterals

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

  self.resolution_mode = attributes[:'resolution_mode'] if attributes[:'resolution_mode']
  self.resolution_mode = "STATIC" if resolution_mode.nil? && !attributes.key?(:'resolutionMode') && !attributes.key?(:'resolution_mode') # rubocop:disable Style/StringLiterals

  self.dnssec_state = attributes[:'dnssecState'] if attributes[:'dnssecState']
  self.dnssec_state = "DISABLED" if dnssec_state.nil? && !attributes.key?(:'dnssecState') # rubocop:disable Style/StringLiterals

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

  self.dnssec_state = attributes[:'dnssec_state'] if attributes[:'dnssec_state']
  self.dnssec_state = "DISABLED" if dnssec_state.nil? && !attributes.key?(:'dnssecState') && !attributes.key?(:'dnssec_state') # rubocop:disable Style/StringLiterals

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

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

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the zone.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<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>>) 


90
91
92
 
# File 'lib/oci/dns/models/zone_summary.rb', line 90

def defined_tags
  @defined_tags
end

#dnssec_config ⇒ OCI::Dns::Models::DnssecConfig

Returns:



164
165
166
 
# File 'lib/oci/dns/models/zone_summary.rb', line 164

def dnssec_config
  @dnssec_config
end

#dnssec_state ⇒ String

[Required] The state of DNSSEC on the zone.

For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC, you must add a DS record to the zone's parent zone containing the KskDnssecKeyVersion data. You can find the DS data in the dsData attribute of the KskDnssecKeyVersion. Then, use the PromoteZoneDnssecKeyVersion operation to promote the KskDnssecKeyVersion.

New KskDnssecKeyVersions are generated annually, a week before the existing KskDnssecKeyVersion's expiration. To rollover a KskDnssecKeyVersion, you must replace the parent zone's DS record containing the old KskDnssecKeyVersion data with the data from the new KskDnssecKeyVersion.

To remove the old DS record without causing service disruption, wait until the old DS record's TTL has expired, and the new DS record has propagated. After the DS replacement has been completed, then the PromoteZoneDnssecKeyVersion operation must be called.

Metrics are emitted in the oci_dns namespace daily for each KskDnssecKeyVersion indicating how many days are left until expiration. We recommend that you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary parent zone updates can be made and the PromoteZoneDnssecKeyVersion operation can be called.

Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency.

For more information, see DNSSEC.

Returns:

  • (String) 


124
125
126
 
# File 'lib/oci/dns/models/zone_summary.rb', line 124

def dnssec_state
  @dnssec_state
end

#freeform_tags ⇒ Hash<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>) 


81
82
83
 
# File 'lib/oci/dns/models/zone_summary.rb', line 81

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the zone.

Returns:

  • (String) 


132
133
134
 
# File 'lib/oci/dns/models/zone_summary.rb', line 132

def id
  @id
end

#is_protected ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


161
162
163
 
# File 'lib/oci/dns/models/zone_summary.rb', line 161

def is_protected
  @is_protected
end

#lifecycle_state ⇒ String

[Required] The current state of the zone resource.

Returns:

  • (String) 


156
157
158
 
# File 'lib/oci/dns/models/zone_summary.rb', line 156

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the zone.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/dns/models/zone_summary.rb', line 52

def name
  @name
end

#resolution_mode ⇒ String

[Required] The resolution mode of a zone defines behavior related to how query responses can be handled. See Private DNS Zone Transparency for more information.

Returns:

  • (String) 


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

def resolution_mode
  @resolution_mode
end

#scope ⇒ String

[Required] The scope of the zone.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/dns/models/zone_summary.rb', line 72

def scope
  @scope
end

#self_uri ⇒ String

[Required] The canonical absolute URL of the resource.

Returns:

  • (String) 


128
129
130
 
# File 'lib/oci/dns/models/zone_summary.rb', line 128

def self_uri
  @self_uri
end

#serial ⇒ Integer

[Required] The current serial of the zone. As seen in the zone's SOA record.

Returns:

  • (Integer) 


152
153
154
 
# File 'lib/oci/dns/models/zone_summary.rb', line 152

def serial
  @serial
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) 


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

def time_created
  @time_created
end

#version ⇒ String

[Required] Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.

Returns:

  • (String) 


147
148
149
 
# File 'lib/oci/dns/models/zone_summary.rb', line 147

def version
  @version
end

#view_id ⇒ String

The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/dns/models/zone_summary.rb', line 68

def view_id
  @view_id
end

#zone_type ⇒ String

[Required] The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/dns/models/zone_summary.rb', line 57

def zone_type
  @zone_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'zone_type': :'zoneType',
    'compartment_id': :'compartmentId',
    'view_id': :'viewId',
    'scope': :'scope',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'resolution_mode': :'resolutionMode',
    'dnssec_state': :'dnssecState',
    'self_uri': :'self',
    'id': :'id',
    'time_created': :'timeCreated',
    'version': :'version',
    'serial': :'serial',
    'lifecycle_state': :'lifecycleState',
    'is_protected': :'isProtected',
    'dnssec_config': :'dnssecConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/dns/models/zone_summary.rb', line 192

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'zone_type': :'String',
    'compartment_id': :'String',
    'view_id': :'String',
    'scope': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'resolution_mode': :'String',
    'dnssec_state': :'String',
    'self_uri': :'String',
    'id': :'String',
    'time_created': :'DateTime',
    'version': :'String',
    'serial': :'Integer',
    'lifecycle_state': :'String',
    'is_protected': :'BOOLEAN',
    'dnssec_config': :'OCI::Dns::Models::DnssecConfig'
    # 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



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/oci/dns/models/zone_summary.rb', line 404

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

  self.class == other.class &&
    name == other.name &&
    zone_type == other.zone_type &&
    compartment_id == other.compartment_id &&
    view_id == other.view_id &&
    scope == other.scope &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    resolution_mode == other.resolution_mode &&
    dnssec_state == other.dnssec_state &&
    self_uri == other.self_uri &&
    id == other.id &&
    time_created == other.time_created &&
    version == other.version &&
    serial == other.serial &&
    lifecycle_state == other.lifecycle_state &&
    is_protected == other.is_protected &&
    dnssec_config == other.dnssec_config
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



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/oci/dns/models/zone_summary.rb', line 450

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


430
431
432
 
# File 'lib/oci/dns/models/zone_summary.rb', line 430

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



439
440
441
 
# File 'lib/oci/dns/models/zone_summary.rb', line 439

def hash
  [name, zone_type, compartment_id, view_id, scope, freeform_tags, defined_tags, resolution_mode, dnssec_state, self_uri, id, time_created, version, serial, lifecycle_state, is_protected, dnssec_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



483
484
485
486
487
488
489
490
491
492
 
# File 'lib/oci/dns/models/zone_summary.rb', line 483

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



477
478
479
 
# File 'lib/oci/dns/models/zone_summary.rb', line 477

def to_s
  to_hash.to_s
end