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/voice-id/VoiceID_EXPORTS.h> 8 #include <aws/voice-id/VoiceIDRequest.h> 9 #include <aws/core/utils/memory/stl/AWSString.h> 10 #include <aws/voice-id/model/SpeakerEnrollmentJobStatus.h> 11 #include <utility> 12 13 namespace Aws 14 { 15 namespace VoiceID 16 { 17 namespace Model 18 { 19 20 /** 21 */ 22 class AWS_VOICEID_API ListSpeakerEnrollmentJobsRequest : public VoiceIDRequest 23 { 24 public: 25 ListSpeakerEnrollmentJobsRequest(); 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 "ListSpeakerEnrollmentJobs"; } 32 33 Aws::String SerializePayload() const override; 34 35 Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; 36 37 38 /** 39 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 40 */ GetDomainId()41 inline const Aws::String& GetDomainId() const{ return m_domainId; } 42 43 /** 44 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 45 */ DomainIdHasBeenSet()46 inline bool DomainIdHasBeenSet() const { return m_domainIdHasBeenSet; } 47 48 /** 49 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 50 */ SetDomainId(const Aws::String & value)51 inline void SetDomainId(const Aws::String& value) { m_domainIdHasBeenSet = true; m_domainId = value; } 52 53 /** 54 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 55 */ SetDomainId(Aws::String && value)56 inline void SetDomainId(Aws::String&& value) { m_domainIdHasBeenSet = true; m_domainId = std::move(value); } 57 58 /** 59 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 60 */ SetDomainId(const char * value)61 inline void SetDomainId(const char* value) { m_domainIdHasBeenSet = true; m_domainId.assign(value); } 62 63 /** 64 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 65 */ WithDomainId(const Aws::String & value)66 inline ListSpeakerEnrollmentJobsRequest& WithDomainId(const Aws::String& value) { SetDomainId(value); return *this;} 67 68 /** 69 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 70 */ WithDomainId(Aws::String && value)71 inline ListSpeakerEnrollmentJobsRequest& WithDomainId(Aws::String&& value) { SetDomainId(std::move(value)); return *this;} 72 73 /** 74 * <p>The identifier of the domain containing the speaker enrollment jobs.</p> 75 */ WithDomainId(const char * value)76 inline ListSpeakerEnrollmentJobsRequest& WithDomainId(const char* value) { SetDomainId(value); return *this;} 77 78 79 /** 80 * <p>Provides the status of your speaker enrollment Job.</p> 81 */ GetJobStatus()82 inline const SpeakerEnrollmentJobStatus& GetJobStatus() const{ return m_jobStatus; } 83 84 /** 85 * <p>Provides the status of your speaker enrollment Job.</p> 86 */ JobStatusHasBeenSet()87 inline bool JobStatusHasBeenSet() const { return m_jobStatusHasBeenSet; } 88 89 /** 90 * <p>Provides the status of your speaker enrollment Job.</p> 91 */ SetJobStatus(const SpeakerEnrollmentJobStatus & value)92 inline void SetJobStatus(const SpeakerEnrollmentJobStatus& value) { m_jobStatusHasBeenSet = true; m_jobStatus = value; } 93 94 /** 95 * <p>Provides the status of your speaker enrollment Job.</p> 96 */ SetJobStatus(SpeakerEnrollmentJobStatus && value)97 inline void SetJobStatus(SpeakerEnrollmentJobStatus&& value) { m_jobStatusHasBeenSet = true; m_jobStatus = std::move(value); } 98 99 /** 100 * <p>Provides the status of your speaker enrollment Job.</p> 101 */ WithJobStatus(const SpeakerEnrollmentJobStatus & value)102 inline ListSpeakerEnrollmentJobsRequest& WithJobStatus(const SpeakerEnrollmentJobStatus& value) { SetJobStatus(value); return *this;} 103 104 /** 105 * <p>Provides the status of your speaker enrollment Job.</p> 106 */ WithJobStatus(SpeakerEnrollmentJobStatus && value)107 inline ListSpeakerEnrollmentJobsRequest& WithJobStatus(SpeakerEnrollmentJobStatus&& value) { SetJobStatus(std::move(value)); return *this;} 108 109 110 /** 111 * <p>The maximum number of results that are returned per call. You can use 112 * <code>NextToken</code> to obtain further pages of results. The default is 100; 113 * the maximum allowed page size is also 100. </p> 114 */ GetMaxResults()115 inline int GetMaxResults() const{ return m_maxResults; } 116 117 /** 118 * <p>The maximum number of results that are returned per call. You can use 119 * <code>NextToken</code> to obtain further pages of results. The default is 100; 120 * the maximum allowed page size is also 100. </p> 121 */ MaxResultsHasBeenSet()122 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } 123 124 /** 125 * <p>The maximum number of results that are returned per call. You can use 126 * <code>NextToken</code> to obtain further pages of results. The default is 100; 127 * the maximum allowed page size is also 100. </p> 128 */ SetMaxResults(int value)129 inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } 130 131 /** 132 * <p>The maximum number of results that are returned per call. You can use 133 * <code>NextToken</code> to obtain further pages of results. The default is 100; 134 * the maximum allowed page size is also 100. </p> 135 */ WithMaxResults(int value)136 inline ListSpeakerEnrollmentJobsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} 137 138 139 /** 140 * <p>If <code>NextToken</code> is returned, there are more results available. The 141 * value of <code>NextToken</code> is a unique pagination token for each page. Make 142 * the call again using the returned token to retrieve the next page. Keep all 143 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 144 */ GetNextToken()145 inline const Aws::String& GetNextToken() const{ return m_nextToken; } 146 147 /** 148 * <p>If <code>NextToken</code> is returned, there are more results available. The 149 * value of <code>NextToken</code> is a unique pagination token for each page. Make 150 * the call again using the returned token to retrieve the next page. Keep all 151 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 152 */ NextTokenHasBeenSet()153 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } 154 155 /** 156 * <p>If <code>NextToken</code> is returned, there are more results available. The 157 * value of <code>NextToken</code> is a unique pagination token for each page. Make 158 * the call again using the returned token to retrieve the next page. Keep all 159 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 160 */ SetNextToken(const Aws::String & value)161 inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } 162 163 /** 164 * <p>If <code>NextToken</code> is returned, there are more results available. The 165 * value of <code>NextToken</code> is a unique pagination token for each page. Make 166 * the call again using the returned token to retrieve the next page. Keep all 167 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 168 */ SetNextToken(Aws::String && value)169 inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } 170 171 /** 172 * <p>If <code>NextToken</code> is returned, there are more results available. The 173 * value of <code>NextToken</code> is a unique pagination token for each page. Make 174 * the call again using the returned token to retrieve the next page. Keep all 175 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 176 */ SetNextToken(const char * value)177 inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } 178 179 /** 180 * <p>If <code>NextToken</code> is returned, there are more results available. The 181 * value of <code>NextToken</code> is a unique pagination token for each page. Make 182 * the call again using the returned token to retrieve the next page. Keep all 183 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 184 */ WithNextToken(const Aws::String & value)185 inline ListSpeakerEnrollmentJobsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} 186 187 /** 188 * <p>If <code>NextToken</code> is returned, there are more results available. The 189 * value of <code>NextToken</code> is a unique pagination token for each page. Make 190 * the call again using the returned token to retrieve the next page. Keep all 191 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 192 */ WithNextToken(Aws::String && value)193 inline ListSpeakerEnrollmentJobsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} 194 195 /** 196 * <p>If <code>NextToken</code> is returned, there are more results available. The 197 * value of <code>NextToken</code> is a unique pagination token for each page. Make 198 * the call again using the returned token to retrieve the next page. Keep all 199 * other arguments unchanged. Each pagination token expires after 24 hours. </p> 200 */ WithNextToken(const char * value)201 inline ListSpeakerEnrollmentJobsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} 202 203 private: 204 205 Aws::String m_domainId; 206 bool m_domainIdHasBeenSet; 207 208 SpeakerEnrollmentJobStatus m_jobStatus; 209 bool m_jobStatusHasBeenSet; 210 211 int m_maxResults; 212 bool m_maxResultsHasBeenSet; 213 214 Aws::String m_nextToken; 215 bool m_nextTokenHasBeenSet; 216 }; 217 218 } // namespace Model 219 } // namespace VoiceID 220 } // namespace Aws 221