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/synthetics/Synthetics_EXPORTS.h>
8 #include <aws/synthetics/SyntheticsRequest.h>
9 #include <aws/core/utils/memory/stl/AWSString.h>
10 #include <utility>
11 
12 namespace Aws
13 {
14 namespace Synthetics
15 {
16 namespace Model
17 {
18 
19   /**
20    */
21   class AWS_SYNTHETICS_API DescribeCanariesRequest : public SyntheticsRequest
22   {
23   public:
24     DescribeCanariesRequest();
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 "DescribeCanaries"; }
31 
32     Aws::String SerializePayload() const override;
33 
34 
35     /**
36      * <p>A token that indicates that there is more data available. You can use this
37      * token in a subsequent operation to retrieve the next set of results.</p>
38      */
GetNextToken()39     inline const Aws::String& GetNextToken() const{ return m_nextToken; }
40 
41     /**
42      * <p>A token that indicates that there is more data available. You can use this
43      * token in a subsequent operation to retrieve the next set of results.</p>
44      */
NextTokenHasBeenSet()45     inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
46 
47     /**
48      * <p>A token that indicates that there is more data available. You can use this
49      * token in a subsequent operation to retrieve the next set of results.</p>
50      */
SetNextToken(const Aws::String & value)51     inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
52 
53     /**
54      * <p>A token that indicates that there is more data available. You can use this
55      * token in a subsequent operation to retrieve the next set of results.</p>
56      */
SetNextToken(Aws::String && value)57     inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
58 
59     /**
60      * <p>A token that indicates that there is more data available. You can use this
61      * token in a subsequent operation to retrieve the next set of results.</p>
62      */
SetNextToken(const char * value)63     inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
64 
65     /**
66      * <p>A token that indicates that there is more data available. You can use this
67      * token in a subsequent operation to retrieve the next set of results.</p>
68      */
WithNextToken(const Aws::String & value)69     inline DescribeCanariesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
70 
71     /**
72      * <p>A token that indicates that there is more data available. You can use this
73      * token in a subsequent operation to retrieve the next set of results.</p>
74      */
WithNextToken(Aws::String && value)75     inline DescribeCanariesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
76 
77     /**
78      * <p>A token that indicates that there is more data available. You can use this
79      * token in a subsequent operation to retrieve the next set of results.</p>
80      */
WithNextToken(const char * value)81     inline DescribeCanariesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
82 
83 
84     /**
85      * <p>Specify this parameter to limit how many canaries are returned each time you
86      * use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
87      * default of 100 is used.</p>
88      */
GetMaxResults()89     inline int GetMaxResults() const{ return m_maxResults; }
90 
91     /**
92      * <p>Specify this parameter to limit how many canaries are returned each time you
93      * use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
94      * default of 100 is used.</p>
95      */
MaxResultsHasBeenSet()96     inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
97 
98     /**
99      * <p>Specify this parameter to limit how many canaries are returned each time you
100      * use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
101      * default of 100 is used.</p>
102      */
SetMaxResults(int value)103     inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
104 
105     /**
106      * <p>Specify this parameter to limit how many canaries are returned each time you
107      * use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
108      * default of 100 is used.</p>
109      */
WithMaxResults(int value)110     inline DescribeCanariesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
111 
112   private:
113 
114     Aws::String m_nextToken;
115     bool m_nextTokenHasBeenSet;
116 
117     int m_maxResults;
118     bool m_maxResultsHasBeenSet;
119   };
120 
121 } // namespace Model
122 } // namespace Synthetics
123 } // namespace Aws
124