Class: Freeclimb::ExportResult

Inherits:
Object
  • Object
show all
Defined in:
lib/freeclimb/models/export_result.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



117
118
119
120
121
122
123
124
125
126
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
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
 
# File 'lib/freeclimb/models/export_result.rb', line 117

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

String that uniquely identifies this account resource.



17
18
19
 
# File 'lib/freeclimb/models/export_result.rb', line 17

def 
  @account_id
end

#date_created ⇒ Object

Returns the value of attribute date_created.



21
22
23
 
# File 'lib/freeclimb/models/export_result.rb', line 21

def date_created
  @date_created
end

#date_updated ⇒ Object

Returns the value of attribute date_updated.



23
24
25
 
# File 'lib/freeclimb/models/export_result.rb', line 23

def date_updated
  @date_updated
end

#export_id ⇒ Object

String that uniquely identifies this export resource



28
29
30
 
# File 'lib/freeclimb/models/export_result.rb', line 28

def export_id
  @export_id
end

#format ⇒ Object

Desired fields of exported documents



40
41
42
 
# File 'lib/freeclimb/models/export_result.rb', line 40

def format
  @format
end

#output ⇒ Object

Returns the value of attribute output.



42
43
44
 
# File 'lib/freeclimb/models/export_result.rb', line 42

def output
  @output
end

#query ⇒ Object

Query params used to filter exported documents



37
38
39
 
# File 'lib/freeclimb/models/export_result.rb', line 37

def query
  @query
end

#resource_type ⇒ Object

Returns the value of attribute resource_type.



34
35
36
 
# File 'lib/freeclimb/models/export_result.rb', line 34

def resource_type
  @resource_type
end

#revision ⇒ Object

Returns the value of attribute revision.



25
26
27
 
# File 'lib/freeclimb/models/export_result.rb', line 25

def revision
  @revision
end

#size ⇒ Object

Returns the value of attribute size.



32
33
34
 
# File 'lib/freeclimb/models/export_result.rb', line 32

def size
  @size
end

#status ⇒ Object

Returns the value of attribute status.



30
31
32
 
# File 'lib/freeclimb/models/export_result.rb', line 30

def status
  @status
end

#uri ⇒ Object

Returns the value of attribute uri.



19
20
21
 
# File 'lib/freeclimb/models/export_result.rb', line 19

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/freeclimb/models/export_result.rb', line 85

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/freeclimb/models/export_result.rb', line 67

def self.attribute_map
  {
    account_id: :accountId,
    uri: :uri,
    date_created: :dateCreated,
    date_updated: :dateUpdated,
    revision: :revision,
    export_id: :exportId,
    status: :status,
    size: :size,
    resource_type: :resourceType,
    query: :query,
    format: :format,
    output: :output
  }
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



290
291
292
 
# File 'lib/freeclimb/models/export_result.rb', line 290

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
 
# File 'lib/freeclimb/models/export_result.rb', line 108

def self.openapi_nullable
  Set.new([
    :account_id,
    :export_id
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/freeclimb/models/export_result.rb', line 90

def self.openapi_types
  {
    account_id: :String,
    uri: :String,
    date_created: :String,
    date_updated: :String,
    revision: :Integer,
    export_id: :String,
    status: :ExportStatus,
    size: :Integer,
    resource_type: :ExportResourceType,
    query: :Object,
    format: :"Array<String>",
    output: :ExportResultOutput
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/freeclimb/models/export_result.rb', line 258

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
     == other. &&
    uri == other.uri &&
    date_created == other.date_created &&
    date_updated == other.date_updated &&
    revision == other.revision &&
    export_id == other.export_id &&
    status == other.status &&
    size == other.size &&
    resource_type == other.resource_type &&
    query == other.query &&
    format == other.format &&
    output == other.output
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/freeclimb/models/export_result.rb', line 320

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 = Freeclimb.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/freeclimb/models/export_result.rb', line 391

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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/freeclimb/models/export_result.rb', line 297

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

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


277
278
279
 
# File 'lib/freeclimb/models/export_result.rb', line 277

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



283
284
285
 
# File 'lib/freeclimb/models/export_result.rb', line 283

def hash
  [, uri, date_created, date_updated, revision, export_id, status, size, resource_type, query, format, output].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



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
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/freeclimb/models/export_result.rb', line 183

def list_invalid_properties
  invalid_properties = []
  if @uri.nil?
    invalid_properties.push('invalid value for "uri", uri cannot be nil.')
  end

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

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

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

  if @revision < 0
    invalid_properties.push('invalid value for "revision", must be greater than or equal to 0.')
  end

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

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

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

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

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

  if @output.nil?
    invalid_properties.push('invalid value for "output", output 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



367
368
369
 
# File 'lib/freeclimb/models/export_result.rb', line 367

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



373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/freeclimb/models/export_result.rb', line 373

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



361
362
363
 
# File 'lib/freeclimb/models/export_result.rb', line 361

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



234
235
236
237
238
239
240
 
# File 'lib/freeclimb/models/export_result.rb', line 234

def valid?
  if @account_id.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end