AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::TranscribeService::Model::ListTranscriptionJobsRequest Class Reference

#include <ListTranscriptionJobsRequest.h>

+ Inheritance diagram for Aws::TranscribeService::Model::ListTranscriptionJobsRequest:

Public Member Functions

 ListTranscriptionJobsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const TranscriptionJobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const TranscriptionJobStatus &value)
 
void SetStatus (TranscriptionJobStatus &&value)
 
ListTranscriptionJobsRequestWithStatus (const TranscriptionJobStatus &value)
 
ListTranscriptionJobsRequestWithStatus (TranscriptionJobStatus &&value)
 
const Aws::StringGetJobNameContains () const
 
bool JobNameContainsHasBeenSet () const
 
void SetJobNameContains (const Aws::String &value)
 
void SetJobNameContains (Aws::String &&value)
 
void SetJobNameContains (const char *value)
 
ListTranscriptionJobsRequestWithJobNameContains (const Aws::String &value)
 
ListTranscriptionJobsRequestWithJobNameContains (Aws::String &&value)
 
ListTranscriptionJobsRequestWithJobNameContains (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListTranscriptionJobsRequestWithNextToken (const Aws::String &value)
 
ListTranscriptionJobsRequestWithNextToken (Aws::String &&value)
 
ListTranscriptionJobsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListTranscriptionJobsRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::TranscribeService::TranscribeServiceRequest
virtual ~TranscribeServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file ListTranscriptionJobsRequest.h.

Constructor & Destructor Documentation

◆ ListTranscriptionJobsRequest()

Aws::TranscribeService::Model::ListTranscriptionJobsRequest::ListTranscriptionJobsRequest ( )

Member Function Documentation

◆ GetJobNameContains()

const Aws::String& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::GetJobNameContains ( ) const
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 91 of file ListTranscriptionJobsRequest.h.

◆ GetMaxResults()

int Aws::TranscribeService::Model::ListTranscriptionJobsRequest::GetMaxResults ( ) const
inline

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 197 of file ListTranscriptionJobsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::GetNextToken ( ) const
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 141 of file ListTranscriptionJobsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::TranscribeService::Model::ListTranscriptionJobsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::TranscribeService::Model::ListTranscriptionJobsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListTranscriptionJobsRequest.h.

◆ GetStatus()

const TranscriptionJobStatus& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::GetStatus ( ) const
inline

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Definition at line 44 of file ListTranscriptionJobsRequest.h.

◆ JobNameContainsHasBeenSet()

bool Aws::TranscribeService::Model::ListTranscriptionJobsRequest::JobNameContainsHasBeenSet ( ) const
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 97 of file ListTranscriptionJobsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::TranscribeService::Model::ListTranscriptionJobsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 203 of file ListTranscriptionJobsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::TranscribeService::Model::ListTranscriptionJobsRequest::NextTokenHasBeenSet ( ) const
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 148 of file ListTranscriptionJobsRequest.h.

◆ SerializePayload()

Aws::String Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobNameContains() [1/3]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetJobNameContains ( const Aws::String value)
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 103 of file ListTranscriptionJobsRequest.h.

◆ SetJobNameContains() [2/3]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetJobNameContains ( Aws::String &&  value)
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 109 of file ListTranscriptionJobsRequest.h.

◆ SetJobNameContains() [3/3]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetJobNameContains ( const char *  value)
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 115 of file ListTranscriptionJobsRequest.h.

◆ SetMaxResults()

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetMaxResults ( int  value)
inline

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 209 of file ListTranscriptionJobsRequest.h.

◆ SetNextToken() [1/3]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetNextToken ( const Aws::String value)
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 155 of file ListTranscriptionJobsRequest.h.

◆ SetNextToken() [2/3]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetNextToken ( Aws::String &&  value)
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 162 of file ListTranscriptionJobsRequest.h.

◆ SetNextToken() [3/3]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetNextToken ( const char *  value)
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 169 of file ListTranscriptionJobsRequest.h.

◆ SetStatus() [1/2]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetStatus ( const TranscriptionJobStatus value)
inline

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Definition at line 60 of file ListTranscriptionJobsRequest.h.

◆ SetStatus() [2/2]

void Aws::TranscribeService::Model::ListTranscriptionJobsRequest::SetStatus ( TranscriptionJobStatus &&  value)
inline

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Definition at line 68 of file ListTranscriptionJobsRequest.h.

◆ StatusHasBeenSet()

bool Aws::TranscribeService::Model::ListTranscriptionJobsRequest::StatusHasBeenSet ( ) const
inline

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Definition at line 52 of file ListTranscriptionJobsRequest.h.

◆ WithJobNameContains() [1/3]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithJobNameContains ( const Aws::String value)
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 121 of file ListTranscriptionJobsRequest.h.

◆ WithJobNameContains() [2/3]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithJobNameContains ( Aws::String &&  value)
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 127 of file ListTranscriptionJobsRequest.h.

◆ WithJobNameContains() [3/3]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithJobNameContains ( const char *  value)
inline

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Definition at line 133 of file ListTranscriptionJobsRequest.h.

◆ WithMaxResults()

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithMaxResults ( int  value)
inline

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Definition at line 215 of file ListTranscriptionJobsRequest.h.

◆ WithNextToken() [1/3]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithNextToken ( const Aws::String value)
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 176 of file ListTranscriptionJobsRequest.h.

◆ WithNextToken() [2/3]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithNextToken ( Aws::String &&  value)
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 183 of file ListTranscriptionJobsRequest.h.

◆ WithNextToken() [3/3]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithNextToken ( const char *  value)
inline

If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

Definition at line 190 of file ListTranscriptionJobsRequest.h.

◆ WithStatus() [1/2]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithStatus ( const TranscriptionJobStatus value)
inline

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Definition at line 76 of file ListTranscriptionJobsRequest.h.

◆ WithStatus() [2/2]

ListTranscriptionJobsRequest& Aws::TranscribeService::Model::ListTranscriptionJobsRequest::WithStatus ( TranscriptionJobStatus &&  value)
inline

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Definition at line 84 of file ListTranscriptionJobsRequest.h.


The documentation for this class was generated from the following file: