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
SCOPE_ENUM = 
[
  SCOPE_GLOBAL = 'GLOBAL'.freeze,
  SCOPE_PRIVATE = 'PRIVATE'.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):



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 103

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']

  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

#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:



50
51
52
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 50

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:



44
45
46
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 44

def external_masters
  @external_masters
end

#scope ⇒ String

The scope of the zone.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 38

def scope
  @scope
end

#view_id ⇒ String

This value will be null for zones in the global DNS.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 34

def view_id
  @view_id
end

#zone_type ⇒ String

The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.

Returns:

  • (String) 


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

def zone_type
  @zone_type
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 53

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

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 71

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>',
    '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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 163

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 202

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


182
183
184
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 182

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 191

def hash
  [migration_source, name, compartment_id, freeform_tags, defined_tags, zone_type, view_id, scope, 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



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 235

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



229
230
231
 
# File 'lib/oci/dns/models/create_zone_details.rb', line 229

def to_s
  to_hash.to_s
end