Class: OCI::Dns::Models::Record

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

Overview

A DNS resource record. For more information, see Supported DNS Resource Record Types.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Record

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :domain (String)

    The value to assign to the #domain property

  • :record_hash (String)

    The value to assign to the #record_hash property

  • :is_protected (BOOLEAN)

    The value to assign to the #is_protected property

  • :rdata (String)

    The value to assign to the #rdata property

  • :rrset_version (String)

    The value to assign to the #rrset_version property

  • :rtype (String)

    The value to assign to the #rtype property

  • :ttl (Integer)

    The value to assign to the #ttl property



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/oci/dns/models/record.rb', line 95

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

  self.record_hash = attributes[:'recordHash'] if attributes[:'recordHash']

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

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

  self.is_protected = attributes[:'isProtected'] unless attributes[:'isProtected'].nil?

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

  self.is_protected = attributes[:'is_protected'] unless attributes[:'is_protected'].nil?

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

  self.rrset_version = attributes[:'rrsetVersion'] if attributes[:'rrsetVersion']

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

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

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

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

Instance Attribute Details

#domainString

The fully qualified domain name where the record can be located.

Returns:

  • (String)


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

def domain
  @domain
end

#is_protectedBOOLEAN

A Boolean flag indicating whether or not parts of the record are unable to be explicitly managed.

Returns:

  • (BOOLEAN)


26
27
28
# File 'lib/oci/dns/models/record.rb', line 26

def is_protected
  @is_protected
end

#rdataString

The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types

Returns:

  • (String)


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

def rdata
  @rdata
end

#record_hashString

A unique identifier for the record within its zone.

Returns:

  • (String)


20
21
22
# File 'lib/oci/dns/models/record.rb', line 20

def record_hash
  @record_hash
end

#rrset_versionString

The latest version of the record's zone in which its RRSet differs from the preceding version.

Returns:

  • (String)


40
41
42
# File 'lib/oci/dns/models/record.rb', line 40

def rrset_version
  @rrset_version
end

#rtypeString

The canonical name for the record's type, such as A or CNAME. For more information, see Resource Record (RR) TYPEs.

Returns:

  • (String)


46
47
48
# File 'lib/oci/dns/models/record.rb', line 46

def rtype
  @rtype
end

#ttlInteger

The Time To Live for the record, in seconds.

Returns:

  • (Integer)


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

def ttl
  @ttl
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'domain': :'domain',
    'record_hash': :'recordHash',
    'is_protected': :'isProtected',
    'rdata': :'rdata',
    'rrset_version': :'rrsetVersion',
    'rtype': :'rtype',
    'ttl': :'ttl'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/oci/dns/models/record.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'domain': :'String',
    'record_hash': :'String',
    'is_protected': :'BOOLEAN',
    'rdata': :'String',
    'rrset_version': :'String',
    'rtype': :'String',
    'ttl': :'Integer'
    # 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



135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/oci/dns/models/record.rb', line 135

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

  self.class == other.class &&
    domain == other.domain &&
    record_hash == other.record_hash &&
    is_protected == other.is_protected &&
    rdata == other.rdata &&
    rrset_version == other.rrset_version &&
    rtype == other.rtype &&
    ttl == other.ttl
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/oci/dns/models/record.rb', line 171

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


151
152
153
# File 'lib/oci/dns/models/record.rb', line 151

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



160
161
162
# File 'lib/oci/dns/models/record.rb', line 160

def hash
  [domain, record_hash, is_protected, rdata, rrset_version, rtype, ttl].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
213
# File 'lib/oci/dns/models/record.rb', line 204

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



198
199
200
# File 'lib/oci/dns/models/record.rb', line 198

def to_s
  to_hash.to_s
end