AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::SWF::Model::GetWorkflowExecutionHistoryRequest Class Reference

#include <GetWorkflowExecutionHistoryRequest.h>

+ Inheritance diagram for Aws::SWF::Model::GetWorkflowExecutionHistoryRequest:

Public Member Functions

 GetWorkflowExecutionHistoryRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDomain () const
 
bool DomainHasBeenSet () const
 
void SetDomain (const Aws::String &value)
 
void SetDomain (Aws::String &&value)
 
void SetDomain (const char *value)
 
GetWorkflowExecutionHistoryRequestWithDomain (const Aws::String &value)
 
GetWorkflowExecutionHistoryRequestWithDomain (Aws::String &&value)
 
GetWorkflowExecutionHistoryRequestWithDomain (const char *value)
 
const WorkflowExecutionGetExecution () const
 
bool ExecutionHasBeenSet () const
 
void SetExecution (const WorkflowExecution &value)
 
void SetExecution (WorkflowExecution &&value)
 
GetWorkflowExecutionHistoryRequestWithExecution (const WorkflowExecution &value)
 
GetWorkflowExecutionHistoryRequestWithExecution (WorkflowExecution &&value)
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
GetWorkflowExecutionHistoryRequestWithNextPageToken (const Aws::String &value)
 
GetWorkflowExecutionHistoryRequestWithNextPageToken (Aws::String &&value)
 
GetWorkflowExecutionHistoryRequestWithNextPageToken (const char *value)
 
int GetMaximumPageSize () const
 
bool MaximumPageSizeHasBeenSet () const
 
void SetMaximumPageSize (int value)
 
GetWorkflowExecutionHistoryRequestWithMaximumPageSize (int value)
 
bool GetReverseOrder () const
 
bool ReverseOrderHasBeenSet () const
 
void SetReverseOrder (bool value)
 
GetWorkflowExecutionHistoryRequestWithReverseOrder (bool value)
 
- Public Member Functions inherited from Aws::SWF::SWFRequest
virtual ~SWFRequest ()
 
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 GetWorkflowExecutionHistoryRequest.h.

Constructor & Destructor Documentation

◆ GetWorkflowExecutionHistoryRequest()

Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetWorkflowExecutionHistoryRequest ( )

Member Function Documentation

◆ DomainHasBeenSet()

bool Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::DomainHasBeenSet ( ) const
inline

The name of the domain containing the workflow execution.

Definition at line 46 of file GetWorkflowExecutionHistoryRequest.h.

◆ ExecutionHasBeenSet()

bool Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::ExecutionHasBeenSet ( ) const
inline

Specifies the workflow execution for which to return the history.

Definition at line 87 of file GetWorkflowExecutionHistoryRequest.h.

◆ GetDomain()

const Aws::String& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetDomain ( ) const
inline

The name of the domain containing the workflow execution.

Definition at line 41 of file GetWorkflowExecutionHistoryRequest.h.

◆ GetExecution()

const WorkflowExecution& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetExecution ( ) const
inline

Specifies the workflow execution for which to return the history.

Definition at line 82 of file GetWorkflowExecutionHistoryRequest.h.

◆ GetMaximumPageSize()

int Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetMaximumPageSize ( ) const
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 211 of file GetWorkflowExecutionHistoryRequest.h.

◆ GetNextPageToken()

const Aws::String& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetNextPageToken ( ) const
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 120 of file GetWorkflowExecutionHistoryRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SWF::SWFRequest.

◆ GetReverseOrder()

bool Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetReverseOrder ( ) const
inline

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Definition at line 237 of file GetWorkflowExecutionHistoryRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetWorkflowExecutionHistoryRequest.h.

◆ MaximumPageSizeHasBeenSet()

bool Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::MaximumPageSizeHasBeenSet ( ) const
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 217 of file GetWorkflowExecutionHistoryRequest.h.

◆ NextPageTokenHasBeenSet()

bool Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::NextPageTokenHasBeenSet ( ) const
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 132 of file GetWorkflowExecutionHistoryRequest.h.

◆ ReverseOrderHasBeenSet()

bool Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::ReverseOrderHasBeenSet ( ) const
inline

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Definition at line 244 of file GetWorkflowExecutionHistoryRequest.h.

◆ SerializePayload()

Aws::String Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDomain() [1/3]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetDomain ( const Aws::String value)
inline

The name of the domain containing the workflow execution.

Definition at line 51 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetDomain() [2/3]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetDomain ( Aws::String &&  value)
inline

The name of the domain containing the workflow execution.

Definition at line 56 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetDomain() [3/3]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetDomain ( const char *  value)
inline

The name of the domain containing the workflow execution.

Definition at line 61 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetExecution() [1/2]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetExecution ( const WorkflowExecution value)
inline

Specifies the workflow execution for which to return the history.

Definition at line 92 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetExecution() [2/2]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetExecution ( WorkflowExecution &&  value)
inline

Specifies the workflow execution for which to return the history.

Definition at line 97 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetMaximumPageSize()

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetMaximumPageSize ( int  value)
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 223 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetNextPageToken() [1/3]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetNextPageToken ( const Aws::String value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 144 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetNextPageToken() [2/3]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetNextPageToken ( Aws::String &&  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 156 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetNextPageToken() [3/3]

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetNextPageToken ( const char *  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 168 of file GetWorkflowExecutionHistoryRequest.h.

◆ SetReverseOrder()

void Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::SetReverseOrder ( bool  value)
inline

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Definition at line 251 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithDomain() [1/3]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithDomain ( const Aws::String value)
inline

The name of the domain containing the workflow execution.

Definition at line 66 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithDomain() [2/3]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithDomain ( Aws::String &&  value)
inline

The name of the domain containing the workflow execution.

Definition at line 71 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithDomain() [3/3]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithDomain ( const char *  value)
inline

The name of the domain containing the workflow execution.

Definition at line 76 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithExecution() [1/2]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithExecution ( const WorkflowExecution value)
inline

Specifies the workflow execution for which to return the history.

Definition at line 102 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithExecution() [2/2]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithExecution ( WorkflowExecution &&  value)
inline

Specifies the workflow execution for which to return the history.

Definition at line 107 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithMaximumPageSize()

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithMaximumPageSize ( int  value)
inline

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Definition at line 229 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithNextPageToken() [1/3]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithNextPageToken ( const Aws::String value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 180 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithNextPageToken() [2/3]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithNextPageToken ( Aws::String &&  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 192 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithNextPageToken() [3/3]

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithNextPageToken ( const char *  value)
inline

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "<code>Specified token has exceeded its maximum lifetime</code>".

The configured maximumPageSize determines how many results can be returned in a single call.

Definition at line 204 of file GetWorkflowExecutionHistoryRequest.h.

◆ WithReverseOrder()

GetWorkflowExecutionHistoryRequest& Aws::SWF::Model::GetWorkflowExecutionHistoryRequest::WithReverseOrder ( bool  value)
inline

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Definition at line 258 of file GetWorkflowExecutionHistoryRequest.h.


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