Class: OCI::Dns::Models::CreateZoneDetails

Inherits:
CreateZoneBaseDetails show all
Defined in:
lib/oci/dns/models/create_zone_details.rb

Overview

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.

Constant Summary collapse

ZONE_TYPE_ENUM =
[
  ZONE_TYPE_PRIMARY = 'PRIMARY'.freeze,
  ZONE_TYPE_SECONDARY = 'SECONDARY'.freeze
].freeze

Constants inherited from CreateZoneBaseDetails

OCI::Dns::Models::CreateZoneBaseDetails::MIGRATION_SOURCE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateZoneBaseDetails

#compartment_id, #defined_tags, #freeform_tags, #migration_source, #name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateZoneBaseDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateZoneDetails

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 proprety

  • :compartment_id (String)

    The value to assign to the #compartment_id proprety

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags proprety

  • :zone_type (String)

    The value to assign to the #zone_type property

  • :external_masters (Array<OCI::Dns::Models::ExternalMaster>)

    The value to assign to the #external_masters property



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/oci/dns/models/create_zone_details.rb', line 72

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

Instance Attribute Details

#external_mastersArray<OCI::Dns::Models::ExternalMaster>

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



28
29
30
# File 'lib/oci/dns/models/create_zone_details.rb', line 28

def external_masters
  @external_masters
end

#zone_typeString

The type of the zone. Must be either PRIMARY or SECONDARY.

Returns:

  • (String)


22
23
24
# File 'lib/oci/dns/models/create_zone_details.rb', line 22

def zone_type
  @zone_type
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/oci/dns/models/create_zone_details.rb', line 31

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',
    'external_masters': :'externalMasters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/oci/dns/models/create_zone_details.rb', line 46

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',
    'external_masters': :'Array<OCI::Dns::Models::ExternalMaster>'
    # 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



110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/oci/dns/models/create_zone_details.rb', line 110

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 &&
    external_masters == other.external_masters
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/dns/models/create_zone_details.rb', line 146

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


126
127
128
# File 'lib/oci/dns/models/create_zone_details.rb', line 126

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



135
136
137
# File 'lib/oci/dns/models/create_zone_details.rb', line 135

def hash
  [migration_source, name, compartment_id, freeform_tags, defined_tags, zone_type, external_masters].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
# File 'lib/oci/dns/models/create_zone_details.rb', line 179

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



173
174
175
# File 'lib/oci/dns/models/create_zone_details.rb', line 173

def to_s
  to_hash.to_s
end