Class: LinodeOpenapiClient::Domain3

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/domain3.rb

Overview

A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode’s nameservers in order for a domain in our system to be treated as authoritative.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Domain3

Initializes the object

Parameters:

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

    Model attributes in the form of hash



136
137
138
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 136

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `LinodeOpenapiClient::Domain3` 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 `LinodeOpenapiClient::Domain3`. 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?(:'retry_sec')
    self.retry_sec = attributes[:'retry_sec']
  else
    self.retry_sec = 0
  end

  if attributes.key?(:'ttl_sec')
    self.ttl_sec = attributes[:'ttl_sec']
  else
    self.ttl_sec = 0
  end

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

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

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

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

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

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

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

  if attributes.key?(:'refresh_sec')
    self.refresh_sec = attributes[:'refresh_sec']
  else
    self.refresh_sec = 0
  end

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

  if attributes.key?(:'expire_sec')
    self.expire_sec = attributes[:'expire_sec']
  else
    self.expire_sec = 0
  end

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = 'active'
  end
end

Instance Attribute Details

#axfr_ips ⇒ Object

The list of IPs that may perform a zone transfer for this Domain. The total combined length of all data within this array cannot exceed 1000 characters. __Note__. This is potentially dangerous, and should be set to an empty list unless you intend to use it.



38
39
40
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 38

def axfr_ips
  @axfr_ips
end

#description ⇒ Object

A description for this Domain. This is for display purposes only.



32
33
34
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 32

def description
  @description
end

#domain ⇒ Object

__Filterable__ The domain this Domain represents. Domain labels cannot be longer than 63 characters and must conform to [RFC1035](tools.ietf.org/html/rfc1035). Domains must be unique on Linode’s platform, including across different Linode accounts; there cannot be two Domains representing the same domain.



56
57
58
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 56

def domain
  @domain
end

#expire_sec ⇒ Object

The amount of time in seconds that may pass before this Domain is no longer authoritative. - Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200. - Any other value is rounded up to the nearest valid value. - A value of 0 is equivalent to the default value of 1209600.



53
54
55
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 53

def expire_sec
  @expire_sec
end

#group ⇒ Object

__Filterable__ The group this Domain belongs to. This is for display purposes only.



50
51
52
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 50

def group
  @group
end

#id ⇒ Object

Read-only This Domain’s unique ID.



41
42
43
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 41

def id
  @id
end

#master_ips ⇒ Object

The IP addresses representing the master DNS for this Domain. At least one value is required for ‘type` slave Domains. The total combined length of all data within this array cannot exceed 1000 characters.



26
27
28
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 26

def master_ips
  @master_ips
end

#refresh_sec ⇒ Object

The amount of time in seconds before this Domain should be refreshed. - Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200. - Any other value is rounded up to the nearest valid value. - A value of 0 is equivalent to the default value of 14400.



47
48
49
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 47

def refresh_sec
  @refresh_sec
end

#retry_sec ⇒ Object

The interval, in seconds, at which a failed refresh should be retried. - Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200. - Any other value is rounded up to the nearest valid value. - A value of 0 is equivalent to the default value of 14400.



20
21
22
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 20

def retry_sec
  @retry_sec
end

#soa_email ⇒ Object

Start of Authority email address. This is required for ‘type` master Domains.



35
36
37
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 35

def soa_email
  @soa_email
end

#status ⇒ Object

Used to control whether this Domain is currently being rendered.



59
60
61
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 59

def status
  @status
end

#tags ⇒ Object

__Filterable__ An array of tags applied to this object. Tags are for organizational purposes only.



44
45
46
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 44

def tags
  @tags
end

#ttl_sec ⇒ Object

"Time to Live" - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. - Valid values are 0, 30, 120, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200. - Any other value is rounded up to the nearest valid value. - A value of 0 is equivalent to the default value of 86400.



23
24
25
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 23

def ttl_sec
  @ttl_sec
end

#type ⇒ Object

Whether this Domain represents the authoritative source of information for the domain it describes (‘master`), or whether it is a read-only copy of a master (`slave`).



29
30
31
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 29

def type
  @type
end

Class Method Details

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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 416

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 84

def self.attribute_map
  {
    :'retry_sec' => :'retry_sec',
    :'ttl_sec' => :'ttl_sec',
    :'master_ips' => :'master_ips',
    :'type' => :'type',
    :'description' => :'description',
    :'soa_email' => :'soa_email',
    :'axfr_ips' => :'axfr_ips',
    :'id' => :'id',
    :'tags' => :'tags',
    :'refresh_sec' => :'refresh_sec',
    :'group' => :'group',
    :'expire_sec' => :'expire_sec',
    :'domain' => :'domain',
    :'status' => :'status'
  }
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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 392

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



129
130
131
132
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 129

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 109

def self.openapi_types
  {
    :'retry_sec' => :'Integer',
    :'ttl_sec' => :'Integer',
    :'master_ips' => :'Array<String>',
    :'type' => :'String',
    :'description' => :'String',
    :'soa_email' => :'String',
    :'axfr_ips' => :'Array<String>',
    :'id' => :'Integer',
    :'tags' => :'Array<String>',
    :'refresh_sec' => :'Integer',
    :'group' => :'String',
    :'expire_sec' => :'Integer',
    :'domain' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 358

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      retry_sec == o.retry_sec &&
      ttl_sec == o.ttl_sec &&
      master_ips == o.master_ips &&
      type == o.type &&
      description == o.description &&
      soa_email == o.soa_email &&
      axfr_ips == o.axfr_ips &&
      id == o.id &&
      tags == o.tags &&
      refresh_sec == o.refresh_sec &&
      group == o.group &&
      expire_sec == o.expire_sec &&
      domain == o.domain &&
      status == o.status
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



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 487

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


379
380
381
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 379

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



385
386
387
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 385

def hash
  [retry_sec, ttl_sec, master_ips, type, description, soa_email, axfr_ips, id, tags, refresh_sec, group, expire_sec, domain, status].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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 224

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 253
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 253.')
  end

  if !@description.nil? && @description.to_s.length < 1
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
  end

  if !@group.nil? && @group.to_s.length > 50
    invalid_properties.push('invalid value for "group", the character length must be smaller than or equal to 50.')
  end

  if !@group.nil? && @group.to_s.length < 1
    invalid_properties.push('invalid value for "group", the character length must be great than or equal to 1.')
  end

  if !@domain.nil? && @domain.to_s.length > 253
    invalid_properties.push('invalid value for "domain", the character length must be smaller than or equal to 253.')
  end

  if !@domain.nil? && @domain.to_s.length < 1
    invalid_properties.push('invalid value for "domain", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/^(\*\.)?([a-zA-Z0-9-_]{1,63}\.)+([a-zA-Z]{2,3}\.)?([a-zA-Z]{2,16}|xn--[a-zA-Z0-9]+)$/)
  if !@domain.nil? && @domain !~ pattern
    invalid_properties.push("invalid value for \"domain\", must conform to the pattern #{pattern}.")
  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



463
464
465
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 463

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



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 469

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



457
458
459
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 457

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/linode_openapi_client/models/domain3.rb', line 261

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["master", "slave"])
  return false unless type_validator.valid?(@type)
  return false if !@description.nil? && @description.to_s.length > 253
  return false if !@description.nil? && @description.to_s.length < 1
  return false if !@group.nil? && @group.to_s.length > 50
  return false if !@group.nil? && @group.to_s.length < 1
  return false if !@domain.nil? && @domain.to_s.length > 253
  return false if !@domain.nil? && @domain.to_s.length < 1
  return false if !@domain.nil? && @domain !~ Regexp.new(/^(\*\.)?([a-zA-Z0-9-_]{1,63}\.)+([a-zA-Z]{2,3}\.)?([a-zA-Z]{2,16}|xn--[a-zA-Z0-9]+)$/)
  status_validator = EnumAttributeValidator.new('String', ["disabled", "active"])
  return false unless status_validator.valid?(@status)
  true
end