Class: MailSlurpClient::DomainNameRecord

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/domain_name_record.rb

Overview

DNS Record required for verification of a domain. Record vary depending on domain type.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainNameRecord

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
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
127
128
129
130
131
132
133
134
135
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 91

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::DomainNameRecord` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::DomainNameRecord`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  end

  if attributes.key?(:'required')
    self.required = attributes[:'required']
  end

  if attributes.key?(:'record_type')
    self.record_type = attributes[:'record_type']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'record_entries')
    if (value = attributes[:'record_entries']).is_a?(Array)
      self.record_entries = value
    end
  end

  if attributes.key?(:'ttl')
    self.ttl = attributes[:'ttl']
  end

  if attributes.key?(:'alternative_record_entries')
    if (value = attributes[:'alternative_record_entries']).is_a?(Array)
      self.alternative_record_entries = value
    end
  end
end

Instance Attribute Details

#alternative_record_entries ⇒ Object

Returns the value of attribute alternative_record_entries.



32
33
34
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 32

def alternative_record_entries
  @alternative_record_entries
end

#label ⇒ Object

Domain Name Server Record Label



19
20
21
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 19

def label
  @label
end

#name ⇒ Object

Returns the value of attribute name.



26
27
28
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 26

def name
  @name
end

#record_entries ⇒ Object

Returns the value of attribute record_entries.



28
29
30
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 28

def record_entries
  @record_entries
end

#record_type ⇒ Object

Domain Name Server Record Types



24
25
26
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 24

def record_type
  @record_type
end

#required ⇒ Object

Returns the value of attribute required.



21
22
23
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 21

def required
  @required
end

#ttl ⇒ Object

Returns the value of attribute ttl.



30
31
32
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 30

def ttl
  @ttl
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 57

def self.attribute_map
  {
    :'label' => :'label',
    :'required' => :'required',
    :'record_type' => :'recordType',
    :'name' => :'name',
    :'record_entries' => :'recordEntries',
    :'ttl' => :'ttl',
    :'alternative_record_entries' => :'alternativeRecordEntries'
  }
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



233
234
235
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 233

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
87
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 83

def self.openapi_nullable
  Set.new([
    :'alternative_record_entries'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 70

def self.openapi_types
  {
    :'label' => :'String',
    :'required' => :'Boolean',
    :'record_type' => :'String',
    :'name' => :'String',
    :'record_entries' => :'Array<String>',
    :'ttl' => :'Integer',
    :'alternative_record_entries' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label == o.label &&
      required == o.required &&
      record_type == o.record_type &&
      name == o.name &&
      record_entries == o.record_entries &&
      ttl == o.ttl &&
      alternative_record_entries == o.alternative_record_entries
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 261

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    MailSlurpClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 330

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

#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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 240

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


220
221
222
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 226

def hash
  [label, required, record_type, name, record_entries, ttl, alternative_record_entries].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 139

def list_invalid_properties
  invalid_properties = Array.new
  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

  if @required.nil?
    invalid_properties.push('invalid value for "required", required cannot be nil.')
  end

  if @record_type.nil?
    invalid_properties.push('invalid value for "record_type", record_type cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @record_entries.nil?
    invalid_properties.push('invalid value for "record_entries", record_entries cannot be nil.')
  end

  if @ttl.nil?
    invalid_properties.push('invalid value for "ttl", ttl cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



306
307
308
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 306

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 312

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



300
301
302
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 300

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/mailslurp_client/models/domain_name_record.rb', line 170

def valid?
  return false if @label.nil?
  label_validator = EnumAttributeValidator.new('String', ["VERIFICATION", "MX", "SPF", "DKIM", "DMARC"])
  return false unless label_validator.valid?(@label)
  return false if @required.nil?
  return false if @record_type.nil?
  record_type_validator = EnumAttributeValidator.new('String', ["A", "NS", "MD", "MF", "CNAME", "SOA", "MB", "MG", "MR", "NULL", "WKS", "PTR", "HINFO", "MINFO", "MX", "TXT", "RP", "AFSDB", "X25", "ISDN", "RT", "NSAP", "NSAP_PTR", "SIG", "KEY", "PX", "GPOS", "AAAA", "LOC", "NXT", "EID", "NIMLOC", "SRV", "ATMA", "NAPTR", "KX", "CERT", "A6", "DNAME", "SINK", "OPT", "APL", "DS", "SSHFP", "IPSECKEY", "RRSIG", "NSEC", "DNSKEY", "DHCID", "NSEC3", "NSEC3PARAM", "TLSA", "SMIMEA", "HIP", "NINFO", "RKEY", "TALINK", "CDS", "CDNSKEY", "OPENPGPKEY", "CSYNC", "ZONEMD", "SVCB", "HTTPS", "SPF", "UINFO", "UID", "GID", "UNSPEC", "NID", "L32", "L64", "LP", "EUI48", "EUI64", "TKEY", "TSIG", "IXFR", "AXFR", "MAILB", "MAILA", "ANY", "URI", "CAA", "AVC", "DOA", "AMTRELAY", "TA", "DLV"])
  return false unless record_type_validator.valid?(@record_type)
  return false if @name.nil?
  return false if @record_entries.nil?
  return false if @ttl.nil?
  true
end