Class: OCI::Dns::Models::UpdateZoneDetails

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

Overview

The body for updating a zone.

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

Constant Summary collapse

RESOLUTION_MODE_ENUM = 
[
  RESOLUTION_MODE_STATIC = 'STATIC'.freeze,
  RESOLUTION_MODE_TRANSPARENT = 'TRANSPARENT'.freeze,
  RESOLUTION_MODE_RTYPE_TRANSPARENT = 'RTYPE_TRANSPARENT'.freeze
].freeze
DNSSEC_STATE_ENUM = 
[
  DNSSEC_STATE_ENABLED = 'ENABLED'.freeze,
  DNSSEC_STATE_DISABLED = 'DISABLED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateZoneDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 129

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

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

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

  self.external_downstreams = attributes[:'externalDownstreams'] if attributes[:'externalDownstreams']

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

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

Instance Attribute Details

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

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


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

def defined_tags
  @defined_tags
end

#dnssec_state ⇒ String

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) 


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

def dnssec_state
  @dnssec_state
end

#external_downstreams ⇒ Array<OCI::Dns::Models::ExternalDownstream>

External secondary servers for the zone. This field is currently not supported when zoneType is SECONDARY or scope is PRIVATE.

Returns:



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

def external_downstreams
  @external_downstreams
end

#external_masters ⇒ Array<OCI::Dns::Models::ExternalMaster>

External master servers for the zone. externalMasters becomes a required parameter when the zoneType value is SECONDARY.

Returns:



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

def external_masters
  @external_masters
end

#freeform_tags ⇒ Hash<String, String>

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


32
33
34
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 32

def freeform_tags
  @freeform_tags
end

#resolution_mode ⇒ String

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) 


46
47
48
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 46

def resolution_mode
  @resolution_mode
end

Class Method Details

.attribute_map ⇒ Object

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



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 90

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'resolution_mode': :'resolutionMode',
    'dnssec_state': :'dnssecState',
    'external_masters': :'externalMasters',
    'external_downstreams': :'externalDownstreams'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 104

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'resolution_mode': :'String',
    'dnssec_state': :'String',
    'external_masters': :'Array<OCI::Dns::Models::ExternalMaster>',
    'external_downstreams': :'Array<OCI::Dns::Models::ExternalDownstream>'
    # 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



199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 199

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

  self.class == other.class &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    resolution_mode == other.resolution_mode &&
    dnssec_state == other.dnssec_state &&
    external_masters == other.external_masters &&
    external_downstreams == other.external_downstreams
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 234

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


214
215
216
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 214

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



223
224
225
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 223

def hash
  [freeform_tags, defined_tags, resolution_mode, dnssec_state, external_masters, external_downstreams].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 267

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



261
262
263
 
# File 'lib/oci/dns/models/update_zone_details.rb', line 261

def to_s
  to_hash.to_s
end