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/comprehend/Comprehend_EXPORTS.h>
8 #include <aws/comprehend/ComprehendRequest.h>
9 #include <aws/comprehend/model/SentimentDetectionJobFilter.h>
10 #include <aws/core/utils/memory/stl/AWSString.h>
11 #include <utility>
12 
13 namespace Aws
14 {
15 namespace Comprehend
16 {
17 namespace Model
18 {
19 
20   /**
21    */
22   class AWS_COMPREHEND_API ListSentimentDetectionJobsRequest : public ComprehendRequest
23   {
24   public:
25     ListSentimentDetectionJobsRequest();
26 
27     // Service request name is the Operation name which will send this request out,
28     // each operation should has unique request name, so that we can get operation's name from this request.
29     // Note: this is not true for response, multiple operations may have the same response name,
30     // so we can not get operation's name from response.
GetServiceRequestName()31     inline virtual const char* GetServiceRequestName() const override { return "ListSentimentDetectionJobs"; }
32 
33     Aws::String SerializePayload() const override;
34 
35     Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
36 
37 
38     /**
39      * <p>Filters the jobs that are returned. You can filter jobs on their name,
40      * status, or the date and time that they were submitted. You can only set one
41      * filter at a time.</p>
42      */
GetFilter()43     inline const SentimentDetectionJobFilter& GetFilter() const{ return m_filter; }
44 
45     /**
46      * <p>Filters the jobs that are returned. You can filter jobs on their name,
47      * status, or the date and time that they were submitted. You can only set one
48      * filter at a time.</p>
49      */
FilterHasBeenSet()50     inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; }
51 
52     /**
53      * <p>Filters the jobs that are returned. You can filter jobs on their name,
54      * status, or the date and time that they were submitted. You can only set one
55      * filter at a time.</p>
56      */
SetFilter(const SentimentDetectionJobFilter & value)57     inline void SetFilter(const SentimentDetectionJobFilter& value) { m_filterHasBeenSet = true; m_filter = value; }
58 
59     /**
60      * <p>Filters the jobs that are returned. You can filter jobs on their name,
61      * status, or the date and time that they were submitted. You can only set one
62      * filter at a time.</p>
63      */
SetFilter(SentimentDetectionJobFilter && value)64     inline void SetFilter(SentimentDetectionJobFilter&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); }
65 
66     /**
67      * <p>Filters the jobs that are returned. You can filter jobs on their name,
68      * status, or the date and time that they were submitted. You can only set one
69      * filter at a time.</p>
70      */
WithFilter(const SentimentDetectionJobFilter & value)71     inline ListSentimentDetectionJobsRequest& WithFilter(const SentimentDetectionJobFilter& value) { SetFilter(value); return *this;}
72 
73     /**
74      * <p>Filters the jobs that are returned. You can filter jobs on their name,
75      * status, or the date and time that they were submitted. You can only set one
76      * filter at a time.</p>
77      */
WithFilter(SentimentDetectionJobFilter && value)78     inline ListSentimentDetectionJobsRequest& WithFilter(SentimentDetectionJobFilter&& value) { SetFilter(std::move(value)); return *this;}
79 
80 
81     /**
82      * <p>Identifies the next page of results to return.</p>
83      */
GetNextToken()84     inline const Aws::String& GetNextToken() const{ return m_nextToken; }
85 
86     /**
87      * <p>Identifies the next page of results to return.</p>
88      */
NextTokenHasBeenSet()89     inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
90 
91     /**
92      * <p>Identifies the next page of results to return.</p>
93      */
SetNextToken(const Aws::String & value)94     inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
95 
96     /**
97      * <p>Identifies the next page of results to return.</p>
98      */
SetNextToken(Aws::String && value)99     inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
100 
101     /**
102      * <p>Identifies the next page of results to return.</p>
103      */
SetNextToken(const char * value)104     inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
105 
106     /**
107      * <p>Identifies the next page of results to return.</p>
108      */
WithNextToken(const Aws::String & value)109     inline ListSentimentDetectionJobsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
110 
111     /**
112      * <p>Identifies the next page of results to return.</p>
113      */
WithNextToken(Aws::String && value)114     inline ListSentimentDetectionJobsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
115 
116     /**
117      * <p>Identifies the next page of results to return.</p>
118      */
WithNextToken(const char * value)119     inline ListSentimentDetectionJobsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
120 
121 
122     /**
123      * <p>The maximum number of results to return in each page. The default is 100.</p>
124      */
GetMaxResults()125     inline int GetMaxResults() const{ return m_maxResults; }
126 
127     /**
128      * <p>The maximum number of results to return in each page. The default is 100.</p>
129      */
MaxResultsHasBeenSet()130     inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
131 
132     /**
133      * <p>The maximum number of results to return in each page. The default is 100.</p>
134      */
SetMaxResults(int value)135     inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
136 
137     /**
138      * <p>The maximum number of results to return in each page. The default is 100.</p>
139      */
WithMaxResults(int value)140     inline ListSentimentDetectionJobsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
141 
142   private:
143 
144     SentimentDetectionJobFilter m_filter;
145     bool m_filterHasBeenSet;
146 
147     Aws::String m_nextToken;
148     bool m_nextTokenHasBeenSet;
149 
150     int m_maxResults;
151     bool m_maxResultsHasBeenSet;
152   };
153 
154 } // namespace Model
155 } // namespace Comprehend
156 } // namespace Aws
157