Class: RagieRubySdk::DocumentGet

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/models/document_get.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentGet

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 95

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

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

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

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

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

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

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

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  else
    self.metadata = nil
  end

  if attributes.key?(:'partition')
    self.partition = attributes[:'partition']
  else
    self.partition = nil
  end

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

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

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

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

Instance Attribute Details

#chunk_count ⇒ Object

Returns the value of attribute chunk_count.



32
33
34
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 32

def chunk_count
  @chunk_count
end

#created_at ⇒ Object

Returns the value of attribute created_at.



22
23
24
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 22

def created_at
  @created_at
end

#errors ⇒ Object

Returns the value of attribute errors.



38
39
40
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 38

def errors
  @errors
end

#external_id ⇒ Object

Returns the value of attribute external_id.



34
35
36
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 34

def external_id
  @external_id
end

#id ⇒ Object

Returns the value of attribute id.



20
21
22
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 20

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



28
29
30
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 28

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



26
27
28
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 26

def name
  @name
end

#page_count ⇒ Object

Returns the value of attribute page_count.



36
37
38
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 36

def page_count
  @page_count
end

#partition ⇒ Object

Returns the value of attribute partition.



30
31
32
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 30

def partition
  @partition
end

#status ⇒ Object

Returns the value of attribute status.



18
19
20
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 18

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



24
25
26
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 24

def updated_at
  @updated_at
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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 366

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 = RagieRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 41

def self.attribute_map
  {
    :'status' => :'status',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name' => :'name',
    :'metadata' => :'metadata',
    :'partition' => :'partition',
    :'chunk_count' => :'chunk_count',
    :'external_id' => :'external_id',
    :'page_count' => :'page_count',
    :'errors' => :'errors'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 342

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



85
86
87
88
89
90
91
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 85

def self.openapi_nullable
  Set.new([
    :'chunk_count',
    :'external_id',
    :'page_count',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'status' => :'String',
    :'id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'metadata' => :'Hash<String, MetadataValue>',
    :'partition' => :'String',
    :'chunk_count' => :'Integer',
    :'external_id' => :'String',
    :'page_count' => :'Float',
    :'errors' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      metadata == o.metadata &&
      partition == o.partition &&
      chunk_count == o.chunk_count &&
      external_id == o.external_id &&
      page_count == o.page_count &&
      errors == o.errors
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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 437

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


329
330
331
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 335

def hash
  [status, id, created_at, updated_at, name, metadata, partition, chunk_count, external_id, page_count, errors].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



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
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 176

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

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

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

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

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

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

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

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



413
414
415
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 419

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



407
408
409
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 407

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



216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/ragie_ruby_sdk/models/document_get.rb', line 216

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @status.nil?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @name.nil?
  return false if @metadata.nil?
  return false if @partition.nil?
  return false if @errors.nil?
  true
end