AWS SDK for C++  0.14.3
AWS SDK for C++
SearchRequest.h
Go to the documentation of this file.
1 /*
2 * Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License").
5 * You may not use this file except in compliance with the License.
6 * A copy of the License is located at
7 *
8 * http://aws.amazon.com/apache2.0
9 *
10 * or in the "license" file accompanying this file. This file is distributed
11 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12 * express or implied. See the License for the specific language governing
13 * permissions and limitations under the License.
14 */
15 #pragma once
20 
21 namespace Aws
22 {
23 namespace Http
24 {
25  class URI;
26 } //namespace Http
27 namespace CloudSearchDomain
28 {
29 namespace Model
30 {
31 
36  {
37  public:
38  SearchRequest();
39  Aws::String SerializePayload() const override;
40 
41  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
42 
54  inline const Aws::String& GetCursor() const{ return m_cursor; }
55 
67  inline void SetCursor(const Aws::String& value) { m_cursorHasBeenSet = true; m_cursor = value; }
68 
80  inline void SetCursor(Aws::String&& value) { m_cursorHasBeenSet = true; m_cursor = value; }
81 
93  inline void SetCursor(const char* value) { m_cursorHasBeenSet = true; m_cursor.assign(value); }
94 
106  inline SearchRequest& WithCursor(const Aws::String& value) { SetCursor(value); return *this;}
107 
119  inline SearchRequest& WithCursor(Aws::String&& value) { SetCursor(value); return *this;}
120 
132  inline SearchRequest& WithCursor(const char* value) { SetCursor(value); return *this;}
133 
146  inline const Aws::String& GetExpr() const{ return m_expr; }
147 
160  inline void SetExpr(const Aws::String& value) { m_exprHasBeenSet = true; m_expr = value; }
161 
174  inline void SetExpr(Aws::String&& value) { m_exprHasBeenSet = true; m_expr = value; }
175 
188  inline void SetExpr(const char* value) { m_exprHasBeenSet = true; m_expr.assign(value); }
189 
202  inline SearchRequest& WithExpr(const Aws::String& value) { SetExpr(value); return *this;}
203 
216  inline SearchRequest& WithExpr(Aws::String&& value) { SetExpr(value); return *this;}
217 
230  inline SearchRequest& WithExpr(const char* value) { SetExpr(value); return *this;}
231 
278  inline const Aws::String& GetFacet() const{ return m_facet; }
279 
326  inline void SetFacet(const Aws::String& value) { m_facetHasBeenSet = true; m_facet = value; }
327 
374  inline void SetFacet(Aws::String&& value) { m_facetHasBeenSet = true; m_facet = value; }
375 
422  inline void SetFacet(const char* value) { m_facetHasBeenSet = true; m_facet.assign(value); }
423 
470  inline SearchRequest& WithFacet(const Aws::String& value) { SetFacet(value); return *this;}
471 
518  inline SearchRequest& WithFacet(Aws::String&& value) { SetFacet(value); return *this;}
519 
566  inline SearchRequest& WithFacet(const char* value) { SetFacet(value); return *this;}
567 
580  inline const Aws::String& GetFilterQuery() const{ return m_filterQuery; }
581 
594  inline void SetFilterQuery(const Aws::String& value) { m_filterQueryHasBeenSet = true; m_filterQuery = value; }
595 
608  inline void SetFilterQuery(Aws::String&& value) { m_filterQueryHasBeenSet = true; m_filterQuery = value; }
609 
622  inline void SetFilterQuery(const char* value) { m_filterQueryHasBeenSet = true; m_filterQuery.assign(value); }
623 
636  inline SearchRequest& WithFilterQuery(const Aws::String& value) { SetFilterQuery(value); return *this;}
637 
650  inline SearchRequest& WithFilterQuery(Aws::String&& value) { SetFilterQuery(value); return *this;}
651 
664  inline SearchRequest& WithFilterQuery(const char* value) { SetFilterQuery(value); return *this;}
665 
692  inline const Aws::String& GetHighlight() const{ return m_highlight; }
693 
720  inline void SetHighlight(const Aws::String& value) { m_highlightHasBeenSet = true; m_highlight = value; }
721 
748  inline void SetHighlight(Aws::String&& value) { m_highlightHasBeenSet = true; m_highlight = value; }
749 
776  inline void SetHighlight(const char* value) { m_highlightHasBeenSet = true; m_highlight.assign(value); }
777 
804  inline SearchRequest& WithHighlight(const Aws::String& value) { SetHighlight(value); return *this;}
805 
832  inline SearchRequest& WithHighlight(Aws::String&& value) { SetHighlight(value); return *this;}
833 
860  inline SearchRequest& WithHighlight(const char* value) { SetHighlight(value); return *this;}
861 
875  inline bool GetPartial() const{ return m_partial; }
876 
890  inline void SetPartial(bool value) { m_partialHasBeenSet = true; m_partial = value; }
891 
905  inline SearchRequest& WithPartial(bool value) { SetPartial(value); return *this;}
906 
918  inline const Aws::String& GetQuery() const{ return m_query; }
919 
931  inline void SetQuery(const Aws::String& value) { m_queryHasBeenSet = true; m_query = value; }
932 
944  inline void SetQuery(Aws::String&& value) { m_queryHasBeenSet = true; m_query = value; }
945 
957  inline void SetQuery(const char* value) { m_queryHasBeenSet = true; m_query.assign(value); }
958 
970  inline SearchRequest& WithQuery(const Aws::String& value) { SetQuery(value); return *this;}
971 
983  inline SearchRequest& WithQuery(Aws::String&& value) { SetQuery(value); return *this;}
984 
996  inline SearchRequest& WithQuery(const char* value) { SetQuery(value); return *this;}
997 
1091  inline const Aws::String& GetQueryOptions() const{ return m_queryOptions; }
1092 
1186  inline void SetQueryOptions(const Aws::String& value) { m_queryOptionsHasBeenSet = true; m_queryOptions = value; }
1187 
1281  inline void SetQueryOptions(Aws::String&& value) { m_queryOptionsHasBeenSet = true; m_queryOptions = value; }
1282 
1376  inline void SetQueryOptions(const char* value) { m_queryOptionsHasBeenSet = true; m_queryOptions.assign(value); }
1377 
1471  inline SearchRequest& WithQueryOptions(const Aws::String& value) { SetQueryOptions(value); return *this;}
1472 
1566  inline SearchRequest& WithQueryOptions(Aws::String&& value) { SetQueryOptions(value); return *this;}
1567 
1661  inline SearchRequest& WithQueryOptions(const char* value) { SetQueryOptions(value); return *this;}
1662 
1697  inline const QueryParser& GetQueryParser() const{ return m_queryParser; }
1698 
1733  inline void SetQueryParser(const QueryParser& value) { m_queryParserHasBeenSet = true; m_queryParser = value; }
1734 
1769  inline void SetQueryParser(QueryParser&& value) { m_queryParserHasBeenSet = true; m_queryParser = value; }
1770 
1805  inline SearchRequest& WithQueryParser(const QueryParser& value) { SetQueryParser(value); return *this;}
1806 
1841  inline SearchRequest& WithQueryParser(QueryParser&& value) { SetQueryParser(value); return *this;}
1842 
1851  inline const Aws::String& GetReturn() const{ return m_return; }
1852 
1861  inline void SetReturn(const Aws::String& value) { m_returnHasBeenSet = true; m_return = value; }
1862 
1871  inline void SetReturn(Aws::String&& value) { m_returnHasBeenSet = true; m_return = value; }
1872 
1881  inline void SetReturn(const char* value) { m_returnHasBeenSet = true; m_return.assign(value); }
1882 
1891  inline SearchRequest& WithReturn(const Aws::String& value) { SetReturn(value); return *this;}
1892 
1901  inline SearchRequest& WithReturn(Aws::String&& value) { SetReturn(value); return *this;}
1902 
1911  inline SearchRequest& WithReturn(const char* value) { SetReturn(value); return *this;}
1912 
1916  inline long long GetSize() const{ return m_size; }
1917 
1921  inline void SetSize(long long value) { m_sizeHasBeenSet = true; m_size = value; }
1922 
1926  inline SearchRequest& WithSize(long long value) { SetSize(value); return *this;}
1927 
1942  inline const Aws::String& GetSort() const{ return m_sort; }
1943 
1958  inline void SetSort(const Aws::String& value) { m_sortHasBeenSet = true; m_sort = value; }
1959 
1974  inline void SetSort(Aws::String&& value) { m_sortHasBeenSet = true; m_sort = value; }
1975 
1990  inline void SetSort(const char* value) { m_sortHasBeenSet = true; m_sort.assign(value); }
1991 
2006  inline SearchRequest& WithSort(const Aws::String& value) { SetSort(value); return *this;}
2007 
2022  inline SearchRequest& WithSort(Aws::String&& value) { SetSort(value); return *this;}
2023 
2038  inline SearchRequest& WithSort(const char* value) { SetSort(value); return *this;}
2039 
2048  inline long long GetStart() const{ return m_start; }
2049 
2058  inline void SetStart(long long value) { m_startHasBeenSet = true; m_start = value; }
2059 
2068  inline SearchRequest& WithStart(long long value) { SetStart(value); return *this;}
2069 
2077  inline const Aws::String& GetStats() const{ return m_stats; }
2078 
2086  inline void SetStats(const Aws::String& value) { m_statsHasBeenSet = true; m_stats = value; }
2087 
2095  inline void SetStats(Aws::String&& value) { m_statsHasBeenSet = true; m_stats = value; }
2096 
2104  inline void SetStats(const char* value) { m_statsHasBeenSet = true; m_stats.assign(value); }
2105 
2113  inline SearchRequest& WithStats(const Aws::String& value) { SetStats(value); return *this;}
2114 
2122  inline SearchRequest& WithStats(Aws::String&& value) { SetStats(value); return *this;}
2123 
2131  inline SearchRequest& WithStats(const char* value) { SetStats(value); return *this;}
2132 
2133  private:
2134  Aws::String m_cursor;
2135  bool m_cursorHasBeenSet;
2136  Aws::String m_expr;
2137  bool m_exprHasBeenSet;
2138  Aws::String m_facet;
2139  bool m_facetHasBeenSet;
2140  Aws::String m_filterQuery;
2141  bool m_filterQueryHasBeenSet;
2142  Aws::String m_highlight;
2143  bool m_highlightHasBeenSet;
2144  bool m_partial;
2145  bool m_partialHasBeenSet;
2146  Aws::String m_query;
2147  bool m_queryHasBeenSet;
2148  Aws::String m_queryOptions;
2149  bool m_queryOptionsHasBeenSet;
2150  QueryParser m_queryParser;
2151  bool m_queryParserHasBeenSet;
2152  Aws::String m_return;
2153  bool m_returnHasBeenSet;
2154  long long m_size;
2155  bool m_sizeHasBeenSet;
2156  Aws::String m_sort;
2157  bool m_sortHasBeenSet;
2158  long long m_start;
2159  bool m_startHasBeenSet;
2160  Aws::String m_stats;
2161  bool m_statsHasBeenSet;
2162  };
2163 
2164 } // namespace Model
2165 } // namespace CloudSearchDomain
2166 } // namespace Aws
SearchRequest & WithHighlight(const Aws::String &value)
const Aws::String & GetQuery() const
const Aws::String & GetQueryOptions() const
const Aws::String & GetCursor() const
Definition: SearchRequest.h:54
SearchRequest & WithExpr(const char *value)
SearchRequest & WithSort(const Aws::String &value)
const QueryParser & GetQueryParser() const
SearchRequest & WithHighlight(const char *value)
void SetQueryParser(const QueryParser &value)
SearchRequest & WithFilterQuery(const Aws::String &value)
SearchRequest & WithQuery(const char *value)
void SetQuery(const Aws::String &value)
void SetFacet(const Aws::String &value)
SearchRequest & WithQueryOptions(const Aws::String &value)
SearchRequest & WithReturn(const Aws::String &value)
void SetStats(const Aws::String &value)
SearchRequest & WithFacet(const Aws::String &value)
SearchRequest & WithQueryOptions(const char *value)
const Aws::String & GetHighlight() const
SearchRequest & WithFilterQuery(Aws::String &&value)
const Aws::String & GetFacet() const
SearchRequest & WithSort(Aws::String &&value)
SearchRequest & WithStats(const char *value)
SearchRequest & WithCursor(Aws::String &&value)
SearchRequest & WithSize(long long value)
SearchRequest & WithFacet(const char *value)
SearchRequest & WithExpr(const Aws::String &value)
const Aws::String & GetReturn() const
SearchRequest & WithStats(const Aws::String &value)
SearchRequest & WithStats(Aws::String &&value)
#define AWS_CLOUDSEARCHDOMAIN_API
SearchRequest & WithReturn(Aws::String &&value)
SearchRequest & WithFilterQuery(const char *value)
SearchRequest & WithExpr(Aws::String &&value)
void SetReturn(const Aws::String &value)
SearchRequest & WithQuery(const Aws::String &value)
SearchRequest & WithQueryOptions(Aws::String &&value)
SearchRequest & WithHighlight(Aws::String &&value)
SearchRequest & WithPartial(bool value)
void SetFilterQuery(const Aws::String &value)
SearchRequest & WithFacet(Aws::String &&value)
void SetExpr(const Aws::String &value)
SearchRequest & WithCursor(const char *value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
SearchRequest & WithQueryParser(QueryParser &&value)
SearchRequest & WithQueryParser(const QueryParser &value)
SearchRequest & WithCursor(const Aws::String &value)
void SetCursor(const Aws::String &value)
Definition: SearchRequest.h:67
const Aws::String & GetExpr() const
void SetHighlight(const Aws::String &value)
void SetQueryOptions(const Aws::String &value)
SearchRequest & WithStart(long long value)
SearchRequest & WithSort(const char *value)
SearchRequest & WithQuery(Aws::String &&value)
SearchRequest & WithReturn(const char *value)
void SetSort(const Aws::String &value)
const Aws::String & GetFilterQuery() const
JSON (JavaScript Object Notation).