Class: Falcon::DomainExternalExportJob

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/domain_external_export_job.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainExternalExportJob

Initializes the object



87
88
89
90
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
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 87

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

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

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

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

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

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

Instance Attribute Details

#created_atObject

Returns the value of attribute created_at.



35
36
37
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 35

def created_at
  @created_at
end

#idObject

Returns the value of attribute id.



37
38
39
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 37

def id
  @id
end

#resourceObject

Resource to be exported



40
41
42
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 40

def resource
  @resource
end

#retriesObject

Number of times the job was retried



43
44
45
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 43

def retries
  @retries
end

#statusObject

Current status of the job. One of [READY, WAITING, IN_PROGRESS, DONE, FAILED, WAITING_FOR_RETRY, CANCELED, RESULT_DELETED]



46
47
48
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 46

def status
  @status
end

#updated_atObject

Returns the value of attribute updated_at.



48
49
50
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 48

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



63
64
65
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 51

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'id' => :'id',
    :'resource' => :'resource',
    :'retries' => :'retries',
    :'status' => :'status',
    :'updated_at' => :'updated_at'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



196
197
198
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 196

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

.openapi_nullableObject

List of attributes with nullable: true



80
81
82
83
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 80

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

.openapi_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 68

def self.openapi_types
  {
    :'created_at' => :'String',
    :'id' => :'String',
    :'resource' => :'String',
    :'retries' => :'Integer',
    :'status' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



170
171
172
173
174
175
176
177
178
179
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      id == o.id &&
      resource == o.resource &&
      retries == o.retries &&
      status == o.status &&
      updated_at == o.updated_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
258
259
260
261
262
263
264
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 227

def _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 = Falcon.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 298

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 203

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


183
184
185
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 183

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.



189
190
191
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 189

def hash
  [created_at, id, resource, retries, status, updated_at].hash
end

#list_invalid_propertiesObject

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 127

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



274
275
276
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 274

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 280

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_sString

Returns the string representation of the object



268
269
270
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 268

def to_s
  to_hash.to_s
end

#valid?Boolean

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



158
159
160
161
162
163
164
165
166
# File 'lib/crimson-falcon/models/domain_external_export_job.rb', line 158

def valid?
  return false if @created_at.nil?
  return false if @id.nil?
  return false if @resource.nil?
  return false if @retries.nil?
  return false if @status.nil?
  return false if @updated_at.nil?
  true
end