Class: TrieveRubyClient::SingleQueuedChunkResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/models/single_queued_chunk_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SingleQueuedChunkResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 52

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

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

Instance Attribute Details

#chunk_metadata ⇒ Object

Returns the value of attribute chunk_metadata.



18
19
20
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 18

def chunk_metadata
  @chunk_metadata
end

#pos_in_queue ⇒ Object

The current position the last access item is in the queue



21
22
23
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 21

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



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
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 151

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



32
33
34
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 32

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



24
25
26
27
28
29
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 24

def self.attribute_map
  {
    :'chunk_metadata' => :'chunk_metadata',
    :'pos_in_queue' => :'pos_in_queue'
  }
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 127

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



45
46
47
48
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 45

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

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 37

def self.openapi_types
  {
    :'chunk_metadata' => :'ChunkMetadata',
    :'pos_in_queue' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



105
106
107
108
109
110
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 105

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      chunk_metadata == o.chunk_metadata &&
      pos_in_queue == o.pos_in_queue
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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 222

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


114
115
116
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 114

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



120
121
122
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 120

def hash
  [chunk_metadata, pos_in_queue].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



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 80

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

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



198
199
200
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 198

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



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 204

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



192
193
194
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 192

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



96
97
98
99
100
101
 
# File 'lib/trieve_ruby_client/models/single_queued_chunk_response.rb', line 96

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @chunk_metadata.nil?
  return false if @pos_in_queue.nil?
  true
end