1 /**
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  * SPDX-License-Identifier: Apache-2.0.
4  */
5 
6 #pragma once
7 #include <aws/kendra/Kendra_EXPORTS.h>
8 #include <aws/kendra/KendraRequest.h>
9 #include <aws/core/utils/memory/stl/AWSString.h>
10 #include <utility>
11 
12 namespace Aws
13 {
14 namespace kendra
15 {
16 namespace Model
17 {
18 
19   /**
20    */
21   class AWS_KENDRA_API ListFaqsRequest : public KendraRequest
22   {
23   public:
24     ListFaqsRequest();
25 
26     // Service request name is the Operation name which will send this request out,
27     // each operation should has unique request name, so that we can get operation's name from this request.
28     // Note: this is not true for response, multiple operations may have the same response name,
29     // so we can not get operation's name from response.
GetServiceRequestName()30     inline virtual const char* GetServiceRequestName() const override { return "ListFaqs"; }
31 
32     Aws::String SerializePayload() const override;
33 
34     Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
35 
36 
37     /**
38      * <p>The index that contains the FAQ lists.</p>
39      */
GetIndexId()40     inline const Aws::String& GetIndexId() const{ return m_indexId; }
41 
42     /**
43      * <p>The index that contains the FAQ lists.</p>
44      */
IndexIdHasBeenSet()45     inline bool IndexIdHasBeenSet() const { return m_indexIdHasBeenSet; }
46 
47     /**
48      * <p>The index that contains the FAQ lists.</p>
49      */
SetIndexId(const Aws::String & value)50     inline void SetIndexId(const Aws::String& value) { m_indexIdHasBeenSet = true; m_indexId = value; }
51 
52     /**
53      * <p>The index that contains the FAQ lists.</p>
54      */
SetIndexId(Aws::String && value)55     inline void SetIndexId(Aws::String&& value) { m_indexIdHasBeenSet = true; m_indexId = std::move(value); }
56 
57     /**
58      * <p>The index that contains the FAQ lists.</p>
59      */
SetIndexId(const char * value)60     inline void SetIndexId(const char* value) { m_indexIdHasBeenSet = true; m_indexId.assign(value); }
61 
62     /**
63      * <p>The index that contains the FAQ lists.</p>
64      */
WithIndexId(const Aws::String & value)65     inline ListFaqsRequest& WithIndexId(const Aws::String& value) { SetIndexId(value); return *this;}
66 
67     /**
68      * <p>The index that contains the FAQ lists.</p>
69      */
WithIndexId(Aws::String && value)70     inline ListFaqsRequest& WithIndexId(Aws::String&& value) { SetIndexId(std::move(value)); return *this;}
71 
72     /**
73      * <p>The index that contains the FAQ lists.</p>
74      */
WithIndexId(const char * value)75     inline ListFaqsRequest& WithIndexId(const char* value) { SetIndexId(value); return *this;}
76 
77 
78     /**
79      * <p>If the previous response was incomplete (because there is more data to
80      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
81      * this pagination token to retrieve the next set of FAQs.</p>
82      */
GetNextToken()83     inline const Aws::String& GetNextToken() const{ return m_nextToken; }
84 
85     /**
86      * <p>If the previous response was incomplete (because there is more data to
87      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
88      * this pagination token to retrieve the next set of FAQs.</p>
89      */
NextTokenHasBeenSet()90     inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
91 
92     /**
93      * <p>If the previous response was incomplete (because there is more data to
94      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
95      * this pagination token to retrieve the next set of FAQs.</p>
96      */
SetNextToken(const Aws::String & value)97     inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
98 
99     /**
100      * <p>If the previous response was incomplete (because there is more data to
101      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
102      * this pagination token to retrieve the next set of FAQs.</p>
103      */
SetNextToken(Aws::String && value)104     inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
105 
106     /**
107      * <p>If the previous response was incomplete (because there is more data to
108      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
109      * this pagination token to retrieve the next set of FAQs.</p>
110      */
SetNextToken(const char * value)111     inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
112 
113     /**
114      * <p>If the previous response was incomplete (because there is more data to
115      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
116      * this pagination token to retrieve the next set of FAQs.</p>
117      */
WithNextToken(const Aws::String & value)118     inline ListFaqsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
119 
120     /**
121      * <p>If the previous response was incomplete (because there is more data to
122      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
123      * this pagination token to retrieve the next set of FAQs.</p>
124      */
WithNextToken(Aws::String && value)125     inline ListFaqsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
126 
127     /**
128      * <p>If the previous response was incomplete (because there is more data to
129      * retrieve), Amazon Kendra returns a pagination token in the response. You can use
130      * this pagination token to retrieve the next set of FAQs.</p>
131      */
WithNextToken(const char * value)132     inline ListFaqsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
133 
134 
135     /**
136      * <p>The maximum number of FAQs to return in the response. If there are fewer
137      * results in the list, this response contains only the actual results.</p>
138      */
GetMaxResults()139     inline int GetMaxResults() const{ return m_maxResults; }
140 
141     /**
142      * <p>The maximum number of FAQs to return in the response. If there are fewer
143      * results in the list, this response contains only the actual results.</p>
144      */
MaxResultsHasBeenSet()145     inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
146 
147     /**
148      * <p>The maximum number of FAQs to return in the response. If there are fewer
149      * results in the list, this response contains only the actual results.</p>
150      */
SetMaxResults(int value)151     inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
152 
153     /**
154      * <p>The maximum number of FAQs to return in the response. If there are fewer
155      * results in the list, this response contains only the actual results.</p>
156      */
WithMaxResults(int value)157     inline ListFaqsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
158 
159   private:
160 
161     Aws::String m_indexId;
162     bool m_indexIdHasBeenSet;
163 
164     Aws::String m_nextToken;
165     bool m_nextTokenHasBeenSet;
166 
167     int m_maxResults;
168     bool m_maxResultsHasBeenSet;
169   };
170 
171 } // namespace Model
172 } // namespace kendra
173 } // namespace Aws
174