class OCI::Dns::Models::CreateZoneBaseDetails

The body for either defining a new zone or migrating a zone from migrationSource. This is determined by the migrationSource discriminator. NONE indicates creation of a new zone (default). DYNECT indicates migration from a DynECT zone.

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

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constants

MIGRATION_SOURCE_ENUM

Attributes

compartment_id[RW]

[Required] The OCID of the compartment containing the zone. @return [String]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

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

@return [Hash<String, Hash<String, Object>>]

freeform_tags[RW]

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: `{"Department": "Finance"}`

@return [Hash<String, String>]

migration_source[R]

Discriminator that is used to determine whether to create a new zone (NONE) or to migrate an existing DynECT zone (DYNECT).

@return [String]

name[RW]

[Required] The name of the zone. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/dns/models/create_zone_base_details.rb, line 52
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'migration_source': :'migrationSource',
    'name': :'name',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end
get_subtype(object_hash) click to toggle source

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

# File lib/oci/dns/models/create_zone_base_details.rb, line 82
def self.get_subtype(object_hash)
  type = object_hash[:'migrationSource'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Dns::Models::CreateZoneDetails' if type == 'NONE'
  return 'OCI::Dns::Models::CreateMigratedDynectZoneDetails' if type == 'DYNECT'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Dns::Models::CreateZoneBaseDetails'
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :migration_source The value to assign to the {#migration_source} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property

# File lib/oci/dns/models/create_zone_base_details.rb, line 104
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.migration_source = attributes[:'migrationSource'] if attributes[:'migrationSource']
  self.migration_source = "NONE" if migration_source.nil? && !attributes.key?(:'migrationSource') # rubocop:disable Style/StringLiterals

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

  self.migration_source = attributes[:'migration_source'] if attributes[:'migration_source']
  self.migration_source = "NONE" if migration_source.nil? && !attributes.key?(:'migrationSource') && !attributes.key?(:'migration_source') # rubocop:disable Style/StringLiterals

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

  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.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']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/dns/models/create_zone_base_details.rb, line 65
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>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/dns/models/create_zone_base_details.rb, line 154
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
end
build_from_hash(attributes) click to toggle source

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_base_details.rb, line 188
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/dns/models/create_zone_base_details.rb, line 168
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/dns/models/create_zone_base_details.rb, line 177
def hash
  [migration_source, name, compartment_id, freeform_tags, defined_tags].hash
end
migration_source=(migration_source) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] migration_source Object to be assigned

# File lib/oci/dns/models/create_zone_base_details.rb, line 143
def migration_source=(migration_source)
  raise "Invalid value for 'migration_source': this must be one of the values in MIGRATION_SOURCE_ENUM." if migration_source && !MIGRATION_SOURCE_ENUM.include?(migration_source)

  @migration_source = migration_source
end
to_hash() click to toggle source

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_base_details.rb, line 221
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/dns/models/create_zone_base_details.rb, line 215
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

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_base_details.rb, line 238
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