Class: UntitledApi::SearchResponse

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

Overview

Response data

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(uri = SKIP, es = SKIP, context = SKIP, stat = SKIP, results = SKIP) ⇒ SearchResponse

Returns a new instance of SearchResponse.



59
60
61
62
63
64
65
66
67
68
69
# File 'lib/untitled_api/models/search_response.rb', line 59

def initialize(uri = SKIP,
               es = SKIP,
               context = SKIP,
               stat = SKIP,
               results = SKIP)
  @uri = uri unless uri == SKIP
  @es = es unless es == SKIP
  @context = context unless context == SKIP
  @stat = stat unless stat == SKIP
  @results = results unless results == SKIP
end

Instance Attribute Details

#contextObject

TODO: Write general description for this method

Returns:

  • (Object)


22
23
24
# File 'lib/untitled_api/models/search_response.rb', line 22

def context
  @context
end

#esObject

TODO: Write general description for this method

Returns:

  • (Object)


18
19
20
# File 'lib/untitled_api/models/search_response.rb', line 18

def es
  @es
end

#resultsObject

TODO: Write general description for this method

Returns:

  • (Object)


30
31
32
# File 'lib/untitled_api/models/search_response.rb', line 30

def results
  @results
end

#statObject

TODO: Write general description for this method

Returns:

  • (Object)


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

def stat
  @stat
end

#uriString

TODO: Write general description for this method

Returns:

  • (String)


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

def uri
  @uri
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/untitled_api/models/search_response.rb', line 72

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  uri = hash.key?('uri') ? hash['uri'] : SKIP
  es = hash.key?('es') ? hash['es'] : SKIP
  context = hash.key?('context') ? hash['context'] : SKIP
  stat = hash.key?('stat') ? hash['stat'] : SKIP
  results = hash.key?('results') ? hash['results'] : SKIP

  # Create object from extracted values.
  SearchResponse.new(uri,
                     es,
                     context,
                     stat,
                     results)
end

.namesObject

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
# File 'lib/untitled_api/models/search_response.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['uri'] = 'uri'
  @_hash['es'] = 'es'
  @_hash['context'] = 'context'
  @_hash['stat'] = 'stat'
  @_hash['results'] = 'results'
  @_hash
end

.nullablesObject

An array for nullable fields



55
56
57
# File 'lib/untitled_api/models/search_response.rb', line 55

def self.nullables
  []
end

.optionalsObject

An array for optional fields



44
45
46
47
48
49
50
51
52
# File 'lib/untitled_api/models/search_response.rb', line 44

def self.optionals
  %w[
    uri
    es
    context
    stat
    results
  ]
end