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/ssm-contacts/SSMContacts_EXPORTS.h>
8 #include <aws/ssm-contacts/SSMContactsRequest.h>
9 #include <aws/core/utils/memory/stl/AWSString.h>
10 #include <aws/ssm-contacts/model/TimeRange.h>
11 #include <utility>
12 
13 namespace Aws
14 {
15 namespace SSMContacts
16 {
17 namespace Model
18 {
19 
20   /**
21    */
22   class AWS_SSMCONTACTS_API ListEngagementsRequest : public SSMContactsRequest
23   {
24   public:
25     ListEngagementsRequest();
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 "ListEngagements"; }
32 
33     Aws::String SerializePayload() const override;
34 
35     Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
36 
37 
38     /**
39      * <p>The pagination token to continue to the next page of results.</p>
40      */
GetNextToken()41     inline const Aws::String& GetNextToken() const{ return m_nextToken; }
42 
43     /**
44      * <p>The pagination token to continue to the next page of results.</p>
45      */
NextTokenHasBeenSet()46     inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
47 
48     /**
49      * <p>The pagination token to continue to the next page 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>The pagination token to continue to the next page of results.</p>
55      */
SetNextToken(Aws::String && value)56     inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
57 
58     /**
59      * <p>The pagination token to continue to the next page of results.</p>
60      */
SetNextToken(const char * value)61     inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
62 
63     /**
64      * <p>The pagination token to continue to the next page of results.</p>
65      */
WithNextToken(const Aws::String & value)66     inline ListEngagementsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
67 
68     /**
69      * <p>The pagination token to continue to the next page of results.</p>
70      */
WithNextToken(Aws::String && value)71     inline ListEngagementsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
72 
73     /**
74      * <p>The pagination token to continue to the next page of results.</p>
75      */
WithNextToken(const char * value)76     inline ListEngagementsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
77 
78 
79     /**
80      * <p>The maximum number of engagements per page of results.</p>
81      */
GetMaxResults()82     inline int GetMaxResults() const{ return m_maxResults; }
83 
84     /**
85      * <p>The maximum number of engagements per page of results.</p>
86      */
MaxResultsHasBeenSet()87     inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
88 
89     /**
90      * <p>The maximum number of engagements per page of results.</p>
91      */
SetMaxResults(int value)92     inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
93 
94     /**
95      * <p>The maximum number of engagements per page of results.</p>
96      */
WithMaxResults(int value)97     inline ListEngagementsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
98 
99 
100     /**
101      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
102      * for.</p>
103      */
GetIncidentId()104     inline const Aws::String& GetIncidentId() const{ return m_incidentId; }
105 
106     /**
107      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
108      * for.</p>
109      */
IncidentIdHasBeenSet()110     inline bool IncidentIdHasBeenSet() const { return m_incidentIdHasBeenSet; }
111 
112     /**
113      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
114      * for.</p>
115      */
SetIncidentId(const Aws::String & value)116     inline void SetIncidentId(const Aws::String& value) { m_incidentIdHasBeenSet = true; m_incidentId = value; }
117 
118     /**
119      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
120      * for.</p>
121      */
SetIncidentId(Aws::String && value)122     inline void SetIncidentId(Aws::String&& value) { m_incidentIdHasBeenSet = true; m_incidentId = std::move(value); }
123 
124     /**
125      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
126      * for.</p>
127      */
SetIncidentId(const char * value)128     inline void SetIncidentId(const char* value) { m_incidentIdHasBeenSet = true; m_incidentId.assign(value); }
129 
130     /**
131      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
132      * for.</p>
133      */
WithIncidentId(const Aws::String & value)134     inline ListEngagementsRequest& WithIncidentId(const Aws::String& value) { SetIncidentId(value); return *this;}
135 
136     /**
137      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
138      * for.</p>
139      */
WithIncidentId(Aws::String && value)140     inline ListEngagementsRequest& WithIncidentId(Aws::String&& value) { SetIncidentId(std::move(value)); return *this;}
141 
142     /**
143      * <p>The Amazon Resource Name (ARN) of the incident you're listing engagements
144      * for.</p>
145      */
WithIncidentId(const char * value)146     inline ListEngagementsRequest& WithIncidentId(const char* value) { SetIncidentId(value); return *this;}
147 
148 
149     /**
150      * <p>The time range to lists engagements for an incident.</p>
151      */
GetTimeRangeValue()152     inline const TimeRange& GetTimeRangeValue() const{ return m_timeRangeValue; }
153 
154     /**
155      * <p>The time range to lists engagements for an incident.</p>
156      */
TimeRangeValueHasBeenSet()157     inline bool TimeRangeValueHasBeenSet() const { return m_timeRangeValueHasBeenSet; }
158 
159     /**
160      * <p>The time range to lists engagements for an incident.</p>
161      */
SetTimeRangeValue(const TimeRange & value)162     inline void SetTimeRangeValue(const TimeRange& value) { m_timeRangeValueHasBeenSet = true; m_timeRangeValue = value; }
163 
164     /**
165      * <p>The time range to lists engagements for an incident.</p>
166      */
SetTimeRangeValue(TimeRange && value)167     inline void SetTimeRangeValue(TimeRange&& value) { m_timeRangeValueHasBeenSet = true; m_timeRangeValue = std::move(value); }
168 
169     /**
170      * <p>The time range to lists engagements for an incident.</p>
171      */
WithTimeRangeValue(const TimeRange & value)172     inline ListEngagementsRequest& WithTimeRangeValue(const TimeRange& value) { SetTimeRangeValue(value); return *this;}
173 
174     /**
175      * <p>The time range to lists engagements for an incident.</p>
176      */
WithTimeRangeValue(TimeRange && value)177     inline ListEngagementsRequest& WithTimeRangeValue(TimeRange&& value) { SetTimeRangeValue(std::move(value)); return *this;}
178 
179   private:
180 
181     Aws::String m_nextToken;
182     bool m_nextTokenHasBeenSet;
183 
184     int m_maxResults;
185     bool m_maxResultsHasBeenSet;
186 
187     Aws::String m_incidentId;
188     bool m_incidentIdHasBeenSet;
189 
190     TimeRange m_timeRangeValue;
191     bool m_timeRangeValueHasBeenSet;
192   };
193 
194 } // namespace Model
195 } // namespace SSMContacts
196 } // namespace Aws
197