Class: GetStream::Generated::Models::SearchResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/search_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ SearchResponse

Initialize with attributes



29
30
31
32
33
34
35
36
 
# File 'lib/getstream_ruby/generated/models/search_response.rb', line 29

def initialize(attributes = {})
  super(attributes)
  @duration = attributes[:duration] || attributes['duration']
  @results = attributes[:results] || attributes['results']
  @next = attributes[:next] || attributes['next'] || nil
  @previous = attributes[:previous] || attributes['previous'] || nil
  @results_warning = attributes[:results_warning] || attributes['results_warning'] || nil
end

Instance Attribute Details

#duration ⇒ String

Returns Duration of the request in milliseconds.

Returns:

  • (String) —

    Duration of the request in milliseconds



14
15
16
 
# File 'lib/getstream_ruby/generated/models/search_response.rb', line 14

def duration
  @duration
end

#next ⇒ String

Returns Value to pass to the next search query in order to paginate.

Returns:

  • (String) —

    Value to pass to the next search query in order to paginate



20
21
22
 
# File 'lib/getstream_ruby/generated/models/search_response.rb', line 20

def next
  @next
end

#previous ⇒ String

Returns Value that points to the previous page. Pass as the next value in a search query to paginate backwards.

Returns:

  • (String) —

    Value that points to the previous page. Pass as the next value in a search query to paginate backwards



23
24
25
 
# File 'lib/getstream_ruby/generated/models/search_response.rb', line 23

def previous
  @previous
end

#results ⇒ Array<SearchResult>

Returns Search results.

Returns:



17
18
19
 
# File 'lib/getstream_ruby/generated/models/search_response.rb', line 17

def results
  @results
end

#results_warning ⇒ SearchWarning

Returns:



26
27
28
 
# File 'lib/getstream_ruby/generated/models/search_response.rb', line 26

def results_warning
  @results_warning
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



39
40
41
42
43
44
45
46
47
 
# File 'lib/getstream_ruby/generated/models/search_response.rb', line 39

def self.json_field_mappings
  {
    duration: 'duration',
    results: 'results',
    next: 'next',
    previous: 'previous',
    results_warning: 'results_warning'
  }
end