Class: OCI::Dns::Models::ExternalMaster

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dns/models/external_master.rb

Overview

An external master name server used as the source of zone data. May either have a zone-embedded TSIG or reference a TSIG key by OCID, but not both.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalMaster

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :address (String)

    The value to assign to the #address property

  • :port (Integer)

    The value to assign to the #port property

  • :tsig (OCI::Dns::Models::TSIG)

    The value to assign to the #tsig property

  • :tsig_key_id (String)

    The value to assign to the #tsig_key_id property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/oci/dns/models/external_master.rb', line 64

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.address = attributes[:'address'] if attributes[:'address']

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

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

  self.tsig_key_id = attributes[:'tsigKeyId'] if attributes[:'tsigKeyId']

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

  self.tsig_key_id = attributes[:'tsig_key_id'] if attributes[:'tsig_key_id']
end

Instance Attribute Details

#addressString

[Required] The server's IP address (IPv4 or IPv6).

Returns:

  • (String)


15
16
17
# File 'lib/oci/dns/models/external_master.rb', line 15

def address
  @address
end

#portInteger

The server's port. Port value must be a value of 53, otherwise omit the port value.

Returns:

  • (Integer)


21
22
23
# File 'lib/oci/dns/models/external_master.rb', line 21

def port
  @port
end

#tsigOCI::Dns::Models::TSIG



24
25
26
# File 'lib/oci/dns/models/external_master.rb', line 24

def tsig
  @tsig
end

#tsig_key_idString

The OCID of the TSIG key.

Returns:

  • (String)


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

def tsig_key_id
  @tsig_key_id
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
# File 'lib/oci/dns/models/external_master.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'address': :'address',
    'port': :'port',
    'tsig': :'tsig',
    'tsig_key_id': :'tsigKeyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
# File 'lib/oci/dns/models/external_master.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'address': :'String',
    'port': :'Integer',
    'tsig': :'OCI::Dns::Models::TSIG',
    'tsig_key_id': :'String'
    # 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



90
91
92
93
94
95
96
97
98
# File 'lib/oci/dns/models/external_master.rb', line 90

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    address == other.address &&
    port == other.port &&
    tsig == other.tsig &&
    tsig_key_id == other.tsig_key_id
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/oci/dns/models/external_master.rb', line 123

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


103
104
105
# File 'lib/oci/dns/models/external_master.rb', line 103

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



112
113
114
# File 'lib/oci/dns/models/external_master.rb', line 112

def hash
  [address, port, tsig, tsig_key_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
# File 'lib/oci/dns/models/external_master.rb', line 156

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



150
151
152
# File 'lib/oci/dns/models/external_master.rb', line 150

def to_s
  to_hash.to_s
end