Class: Azure::CognitiveServices::CustomSearch::V1_0::Models::SearchResponse

Inherits:
Response show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_customsearch/models/search_response.rb

Overview

Defines the top-level object that the response includes when the request succeeds.

Instance Attribute Summary collapse

Attributes inherited from Response

#web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SearchResponse 



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

def initialize
  @_type = "SearchResponse"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



21
22
23
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/search_response.rb', line 21

def _type
  @_type
end

#query_context ⇒ QueryContext

Bing used for the request. This object contains the query string as entered by the user. It may also contain an altered query string that Bing used for the query if the query string contained a spelling mistake.



28
29
30
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/search_response.rb', line 28

def query_context
  @query_context
end

#web_pages ⇒ WebWebAnswer

search query.



32
33
34
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/search_response.rb', line 32

def web_pages
  @web_pages
end

Class Method Details

.mapper ⇒ Object

Mapper for SearchResponse class as Ruby Hash. This will be used for serialization/deserialization.



39
40
41
42
43
44
45
46
47
48
49
50
51
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/search_response.rb', line 39

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'SearchResponse',
    type: {
      name: 'Composite',
      class_name: 'SearchResponse',
      model_properties: {
        _type: {
          client_side_validation: true,
          required: true,
          serialized_name: '_type',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        query_context: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'queryContext',
          type: {
            name: 'Composite',
            class_name: 'QueryContext'
          }
        },
        web_pages: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webPages',
          type: {
            name: 'Composite',
            class_name: 'WebWebAnswer'
          }
        }
      }
    }
  }
end