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

#include <ListCallAnalyticsJobsRequest.h>

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

Public Member Functions

 ListCallAnalyticsJobsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const CallAnalyticsJobStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const CallAnalyticsJobStatus &value)
 
void SetStatus (CallAnalyticsJobStatus &&value)
 
ListCallAnalyticsJobsRequestWithStatus (const CallAnalyticsJobStatus &value)
 
ListCallAnalyticsJobsRequestWithStatus (CallAnalyticsJobStatus &&value)
 
const Aws::StringGetJobNameContains () const
 
bool JobNameContainsHasBeenSet () const
 
void SetJobNameContains (const Aws::String &value)
 
void SetJobNameContains (Aws::String &&value)
 
void SetJobNameContains (const char *value)
 
ListCallAnalyticsJobsRequestWithJobNameContains (const Aws::String &value)
 
ListCallAnalyticsJobsRequestWithJobNameContains (Aws::String &&value)
 
ListCallAnalyticsJobsRequestWithJobNameContains (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)
 
ListCallAnalyticsJobsRequestWithNextToken (const Aws::String &value)
 
ListCallAnalyticsJobsRequestWithNextToken (Aws::String &&value)
 
ListCallAnalyticsJobsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListCallAnalyticsJobsRequestWithMaxResults (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 ListCallAnalyticsJobsRequest.h.

Constructor & Destructor Documentation

◆ ListCallAnalyticsJobsRequest()

Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::ListCallAnalyticsJobsRequest ( )

Member Function Documentation

◆ GetJobNameContains()

const Aws::String& Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ GetMaxResults()

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

The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Definition at line 190 of file ListCallAnalyticsJobsRequest.h.

◆ GetNextToken()

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 140 of file ListCallAnalyticsJobsRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListCallAnalyticsJobsRequest.h.

◆ GetStatus()

const CallAnalyticsJobStatus& Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::GetStatus ( ) const
inline

When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

Definition at line 44 of file ListCallAnalyticsJobsRequest.h.

◆ JobNameContainsHasBeenSet()

bool Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Definition at line 197 of file ListCallAnalyticsJobsRequest.h.

◆ NextTokenHasBeenSet()

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 146 of file ListCallAnalyticsJobsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetJobNameContains() [1/3]

void Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ SetJobNameContains() [2/3]

void Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ SetJobNameContains() [3/3]

void Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ SetMaxResults()

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

The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Definition at line 204 of file ListCallAnalyticsJobsRequest.h.

◆ SetNextToken() [1/3]

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 158 of file ListCallAnalyticsJobsRequest.h.

◆ SetNextToken() [2/3]

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 152 of file ListCallAnalyticsJobsRequest.h.

◆ SetNextToken() [3/3]

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 164 of file ListCallAnalyticsJobsRequest.h.

◆ SetStatus() [1/2]

void Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::SetStatus ( CallAnalyticsJobStatus &&  value)
inline

When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

Definition at line 68 of file ListCallAnalyticsJobsRequest.h.

◆ SetStatus() [2/2]

void Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::SetStatus ( const CallAnalyticsJobStatus value)
inline

When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

Definition at line 60 of file ListCallAnalyticsJobsRequest.h.

◆ StatusHasBeenSet()

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

When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

Definition at line 52 of file ListCallAnalyticsJobsRequest.h.

◆ WithJobNameContains() [1/3]

ListCallAnalyticsJobsRequest& Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ WithJobNameContains() [2/3]

ListCallAnalyticsJobsRequest& Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ WithJobNameContains() [3/3]

ListCallAnalyticsJobsRequest& Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::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 ListCallAnalyticsJobsRequest.h.

◆ WithMaxResults()

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

The maximum number of call analytics jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Definition at line 211 of file ListCallAnalyticsJobsRequest.h.

◆ WithNextToken() [1/3]

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 176 of file ListCallAnalyticsJobsRequest.h.

◆ WithNextToken() [2/3]

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 170 of file ListCallAnalyticsJobsRequest.h.

◆ WithNextToken() [3/3]

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

If you receive a truncated result in the previous request of , include NextToken to fetch the next set of jobs.

Definition at line 182 of file ListCallAnalyticsJobsRequest.h.

◆ WithStatus() [1/2]

ListCallAnalyticsJobsRequest& Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::WithStatus ( CallAnalyticsJobStatus &&  value)
inline

When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

Definition at line 84 of file ListCallAnalyticsJobsRequest.h.

◆ WithStatus() [2/2]

ListCallAnalyticsJobsRequest& Aws::TranscribeService::Model::ListCallAnalyticsJobsRequest::WithStatus ( const CallAnalyticsJobStatus value)
inline

When specified, returns only call analytics jobs with the specified status. Jobs are ordered by creation date, with the most recent jobs returned first. If you don't specify a status, Amazon Transcribe returns all analytics jobs ordered by creation date.

Definition at line 76 of file ListCallAnalyticsJobsRequest.h.


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