AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::Transfer::Model::ListExecutionsRequest Class Reference

#include <ListExecutionsRequest.h>

+ Inheritance diagram for Aws::Transfer::Model::ListExecutionsRequest:

Public Member Functions

 ListExecutionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListExecutionsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListExecutionsRequestWithNextToken (const Aws::String &value)
 
ListExecutionsRequestWithNextToken (Aws::String &&value)
 
ListExecutionsRequestWithNextToken (const char *value)
 
const Aws::StringGetWorkflowId () const
 
bool WorkflowIdHasBeenSet () const
 
void SetWorkflowId (const Aws::String &value)
 
void SetWorkflowId (Aws::String &&value)
 
void SetWorkflowId (const char *value)
 
ListExecutionsRequestWithWorkflowId (const Aws::String &value)
 
ListExecutionsRequestWithWorkflowId (Aws::String &&value)
 
ListExecutionsRequestWithWorkflowId (const char *value)
 
- Public Member Functions inherited from Aws::Transfer::TransferRequest
virtual ~TransferRequest ()
 
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 21 of file ListExecutionsRequest.h.

Constructor & Destructor Documentation

◆ ListExecutionsRequest()

Aws::Transfer::Model::ListExecutionsRequest::ListExecutionsRequest ( )

Member Function Documentation

◆ GetMaxResults()

int Aws::Transfer::Model::ListExecutionsRequest::GetMaxResults ( ) const
inline

Specifies the aximum number of executions to return.

Definition at line 40 of file ListExecutionsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Transfer::Model::ListExecutionsRequest::GetNextToken ( ) const
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 74 of file ListExecutionsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Transfer::Model::ListExecutionsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Transfer::TransferRequest.

◆ GetServiceRequestName()

virtual const char* Aws::Transfer::Model::ListExecutionsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListExecutionsRequest.h.

◆ GetWorkflowId()

const Aws::String& Aws::Transfer::Model::ListExecutionsRequest::GetWorkflowId ( ) const
inline

A unique identifier for the workflow.

Definition at line 206 of file ListExecutionsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Transfer::Model::ListExecutionsRequest::MaxResultsHasBeenSet ( ) const
inline

Specifies the aximum number of executions to return.

Definition at line 45 of file ListExecutionsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Transfer::Model::ListExecutionsRequest::NextTokenHasBeenSet ( ) const
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 92 of file ListExecutionsRequest.h.

◆ SerializePayload()

Aws::String Aws::Transfer::Model::ListExecutionsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::Transfer::Model::ListExecutionsRequest::SetMaxResults ( int  value)
inline

Specifies the aximum number of executions to return.

Definition at line 50 of file ListExecutionsRequest.h.

◆ SetNextToken() [1/3]

void Aws::Transfer::Model::ListExecutionsRequest::SetNextToken ( Aws::String &&  value)
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 128 of file ListExecutionsRequest.h.

◆ SetNextToken() [2/3]

void Aws::Transfer::Model::ListExecutionsRequest::SetNextToken ( const Aws::String value)
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 110 of file ListExecutionsRequest.h.

◆ SetNextToken() [3/3]

void Aws::Transfer::Model::ListExecutionsRequest::SetNextToken ( const char *  value)
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 146 of file ListExecutionsRequest.h.

◆ SetWorkflowId() [1/3]

void Aws::Transfer::Model::ListExecutionsRequest::SetWorkflowId ( Aws::String &&  value)
inline

A unique identifier for the workflow.

Definition at line 221 of file ListExecutionsRequest.h.

◆ SetWorkflowId() [2/3]

void Aws::Transfer::Model::ListExecutionsRequest::SetWorkflowId ( const Aws::String value)
inline

A unique identifier for the workflow.

Definition at line 216 of file ListExecutionsRequest.h.

◆ SetWorkflowId() [3/3]

void Aws::Transfer::Model::ListExecutionsRequest::SetWorkflowId ( const char *  value)
inline

A unique identifier for the workflow.

Definition at line 226 of file ListExecutionsRequest.h.

◆ WithMaxResults()

ListExecutionsRequest& Aws::Transfer::Model::ListExecutionsRequest::WithMaxResults ( int  value)
inline

Specifies the aximum number of executions to return.

Definition at line 55 of file ListExecutionsRequest.h.

◆ WithNextToken() [1/3]

ListExecutionsRequest& Aws::Transfer::Model::ListExecutionsRequest::WithNextToken ( Aws::String &&  value)
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 182 of file ListExecutionsRequest.h.

◆ WithNextToken() [2/3]

ListExecutionsRequest& Aws::Transfer::Model::ListExecutionsRequest::WithNextToken ( const Aws::String value)
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 164 of file ListExecutionsRequest.h.

◆ WithNextToken() [3/3]

ListExecutionsRequest& Aws::Transfer::Model::ListExecutionsRequest::WithNextToken ( const char *  value)
inline

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, callthe API by specifing the max-results:

aws transfer list-executions –max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions –max-results 10 –next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Definition at line 200 of file ListExecutionsRequest.h.

◆ WithWorkflowId() [1/3]

ListExecutionsRequest& Aws::Transfer::Model::ListExecutionsRequest::WithWorkflowId ( Aws::String &&  value)
inline

A unique identifier for the workflow.

Definition at line 236 of file ListExecutionsRequest.h.

◆ WithWorkflowId() [2/3]

ListExecutionsRequest& Aws::Transfer::Model::ListExecutionsRequest::WithWorkflowId ( const Aws::String value)
inline

A unique identifier for the workflow.

Definition at line 231 of file ListExecutionsRequest.h.

◆ WithWorkflowId() [3/3]

ListExecutionsRequest& Aws::Transfer::Model::ListExecutionsRequest::WithWorkflowId ( const char *  value)
inline

A unique identifier for the workflow.

Definition at line 241 of file ListExecutionsRequest.h.

◆ WorkflowIdHasBeenSet()

bool Aws::Transfer::Model::ListExecutionsRequest::WorkflowIdHasBeenSet ( ) const
inline

A unique identifier for the workflow.

Definition at line 211 of file ListExecutionsRequest.h.


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