class OCI::Dns::Models::CreateZoneDetails
The body for defining a new zone.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Constants
- SCOPE_ENUM
- ZONE_TYPE_ENUM
Attributes
External master servers for the zone. `externalMasters` becomes a required parameter when the `zoneType` value is `SECONDARY`.
@return [Array<OCI::Dns::Models::ExternalMaster>]
The scope of the zone. @return [String]
This value will be null for zones in the global DNS.
@return [String]
The type of the zone. Must be either `PRIMARY` or `SECONDARY`. `SECONDARY` is only supported for GLOBAL zones.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/dns/models/create_zone_details.rb, line 46 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'migration_source': :'migrationSource', 'name': :'name', 'compartment_id': :'compartmentId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'zone_type': :'zoneType', 'view_id': :'viewId', 'scope': :'scope', 'external_masters': :'externalMasters' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {OCI::Dns::Models::CreateZoneBaseDetails#name name
} proprety @option attributes [String] :compartment_id The value to assign to the {OCI::Dns::Models::CreateZoneBaseDetails#compartment_id compartment_id
} proprety @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {OCI::Dns::Models::CreateZoneBaseDetails#freeform_tags freeform_tags
} proprety @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {OCI::Dns::Models::CreateZoneBaseDetails#defined_tags defined_tags
} proprety @option attributes [String] :zone_type The value to assign to the {#zone_type} property @option attributes [String] :view_id The value to assign to the {#view_id} property @option attributes [String] :scope The value to assign to the {#scope} property @option attributes [Array<OCI::Dns::Models::ExternalMaster>] :external_masters The value to assign to the {#external_masters} property
OCI::Dns::Models::CreateZoneBaseDetails::new
# File lib/oci/dns/models/create_zone_details.rb, line 93 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['migrationSource'] = 'NONE' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } 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.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.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'] end
Attribute type mapping.
# File lib/oci/dns/models/create_zone_details.rb, line 63 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'migration_source': :'String', 'name': :'String', 'compartment_id': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'zone_type': :'String', 'view_id': :'String', 'scope': :'String', 'external_masters': :'Array<OCI::Dns::Models::ExternalMaster>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/dns/models/create_zone_details.rb, line 147 def ==(other) return true if equal?(other) self.class == other.class && migration_source == other.migration_source && name == other.name && compartment_id == other.compartment_id && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && zone_type == other.zone_type && view_id == other.view_id && scope == other.scope && external_masters == other.external_masters end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/dns/models/create_zone_details.rb, line 185 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/dns/models/create_zone_details.rb, line 165 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/dns/models/create_zone_details.rb, line 174 def hash [migration_source, name, compartment_id, freeform_tags, defined_tags, zone_type, view_id, scope, external_masters].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] scope Object
to be assigned
# File lib/oci/dns/models/create_zone_details.rb, line 136 def scope=(scope) raise "Invalid value for 'scope': this must be one of the values in SCOPE_ENUM." if scope && !SCOPE_ENUM.include?(scope) @scope = scope end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/dns/models/create_zone_details.rb, line 218 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/dns/models/create_zone_details.rb, line 212 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] zone_type
Object
to be assigned
# File lib/oci/dns/models/create_zone_details.rb, line 128 def zone_type=(zone_type) raise "Invalid value for 'zone_type': this must be one of the values in ZONE_TYPE_ENUM." if zone_type && !ZONE_TYPE_ENUM.include?(zone_type) @zone_type = zone_type end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/dns/models/create_zone_details.rb, line 235 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end