Class: OCI::Dns::Models::Zone
- Inherits:
-
Object
- Object
- OCI::Dns::Models::Zone
- Defined in:
- lib/oci/dns/models/zone.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
- 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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID of the compartment containing the zone.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#external_masters ⇒ Array<OCI::Dns::Models::ExternalMaster>
External master servers for the zone.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
The OCID of the zone.
-
#lifecycle_state ⇒ String
The current state of the zone resource.
-
#name ⇒ String
The name of the zone.
-
#nameservers ⇒ Array<OCI::Dns::Models::Nameserver>
The authoritative nameservers for the zone.
-
#self_uri ⇒ String
The canonical absolute URL of the resource.
-
#serial ⇒ Integer
The current serial of the zone.
-
#time_created ⇒ DateTime
The date and time the resource was created in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
-
#version ⇒ String
Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.
-
#zone_type ⇒ String
The type of the zone.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Zone
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Zone
Initializes the object
163 164 165 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 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 |
# File 'lib/oci/dns/models/zone.rb', line 163 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] 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.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.nameservers = attributes[:'nameservers'] if attributes[:'nameservers'] end |
Instance Attribute Details
#compartment_id ⇒ String
The OCID of the compartment containing the zone.
40 41 42 |
# File 'lib/oci/dns/models/zone.rb', line 40 def compartment_id @compartment_id end |
#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\"}}
58 59 60 |
# File 'lib/oci/dns/models/zone.rb', line 58 def @defined_tags 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
.
64 65 66 |
# File 'lib/oci/dns/models/zone.rb', line 64 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\"}
49 50 51 |
# File 'lib/oci/dns/models/zone.rb', line 49 def @freeform_tags end |
#id ⇒ String
The OCID of the zone.
72 73 74 |
# File 'lib/oci/dns/models/zone.rb', line 72 def id @id end |
#lifecycle_state ⇒ String
The current state of the zone resource.
96 97 98 |
# File 'lib/oci/dns/models/zone.rb', line 96 def lifecycle_state @lifecycle_state end |
#name ⇒ String
The name of the zone.
31 32 33 |
# File 'lib/oci/dns/models/zone.rb', line 31 def name @name end |
#nameservers ⇒ Array<OCI::Dns::Models::Nameserver>
The authoritative nameservers for the zone.
100 101 102 |
# File 'lib/oci/dns/models/zone.rb', line 100 def nameservers @nameservers end |
#self_uri ⇒ String
The canonical absolute URL of the resource.
68 69 70 |
# File 'lib/oci/dns/models/zone.rb', line 68 def self_uri @self_uri end |
#serial ⇒ Integer
The current serial of the zone. As seen in the zone's SOA record.
92 93 94 |
# File 'lib/oci/dns/models/zone.rb', line 92 def serial @serial end |
#time_created ⇒ DateTime
The date and time the resource was created in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
Example: 2016-07-22T17:23:59:60Z
80 81 82 |
# File 'lib/oci/dns/models/zone.rb', line 80 def time_created @time_created end |
#version ⇒ String
Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.
87 88 89 |
# File 'lib/oci/dns/models/zone.rb', line 87 def version @version end |
#zone_type ⇒ String
The type of the zone. Must be either PRIMARY
or SECONDARY
.
36 37 38 |
# File 'lib/oci/dns/models/zone.rb', line 36 def zone_type @zone_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/oci/dns/models/zone.rb', line 103 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'zone_type': :'zoneType', 'compartment_id': :'compartmentId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'external_masters': :'externalMasters', 'self_uri': :'self', 'id': :'id', 'time_created': :'timeCreated', 'version': :'version', 'serial': :'serial', 'lifecycle_state': :'lifecycleState', 'nameservers': :'nameservers' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/oci/dns/models/zone.rb', line 124 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'zone_type': :'String', 'compartment_id': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'external_masters': :'Array<OCI::Dns::Models::ExternalMaster>', 'self_uri': :'String', 'id': :'String', 'time_created': :'DateTime', 'version': :'String', 'serial': :'Integer', 'lifecycle_state': :'String', 'nameservers': :'Array<OCI::Dns::Models::Nameserver>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/oci/dns/models/zone.rb', line 261 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && zone_type == other.zone_type && compartment_id == other.compartment_id && == other. && == other. && external_masters == other.external_masters && self_uri == other.self_uri && id == other.id && time_created == other.time_created && version == other.version && serial == other.serial && lifecycle_state == other.lifecycle_state && nameservers == other.nameservers end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/oci/dns/models/zone.rb', line 303 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
283 284 285 |
# File 'lib/oci/dns/models/zone.rb', line 283 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
292 293 294 |
# File 'lib/oci/dns/models/zone.rb', line 292 def hash [name, zone_type, compartment_id, , , external_masters, self_uri, id, time_created, version, serial, lifecycle_state, nameservers].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
336 337 338 339 340 341 342 343 344 345 |
# File 'lib/oci/dns/models/zone.rb', line 336 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
330 331 332 |
# File 'lib/oci/dns/models/zone.rb', line 330 def to_s to_hash.to_s end |