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

#include <PollForDecisionTaskRequest.h>

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

Public Member Functions

 PollForDecisionTaskRequest ()
 
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)
 
PollForDecisionTaskRequestWithDomain (const Aws::String &value)
 
PollForDecisionTaskRequestWithDomain (Aws::String &&value)
 
PollForDecisionTaskRequestWithDomain (const char *value)
 
const TaskListGetTaskList () const
 
bool TaskListHasBeenSet () const
 
void SetTaskList (const TaskList &value)
 
void SetTaskList (TaskList &&value)
 
PollForDecisionTaskRequestWithTaskList (const TaskList &value)
 
PollForDecisionTaskRequestWithTaskList (TaskList &&value)
 
const Aws::StringGetIdentity () const
 
bool IdentityHasBeenSet () const
 
void SetIdentity (const Aws::String &value)
 
void SetIdentity (Aws::String &&value)
 
void SetIdentity (const char *value)
 
PollForDecisionTaskRequestWithIdentity (const Aws::String &value)
 
PollForDecisionTaskRequestWithIdentity (Aws::String &&value)
 
PollForDecisionTaskRequestWithIdentity (const char *value)
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
PollForDecisionTaskRequestWithNextPageToken (const Aws::String &value)
 
PollForDecisionTaskRequestWithNextPageToken (Aws::String &&value)
 
PollForDecisionTaskRequestWithNextPageToken (const char *value)
 
int GetMaximumPageSize () const
 
bool MaximumPageSizeHasBeenSet () const
 
void SetMaximumPageSize (int value)
 
PollForDecisionTaskRequestWithMaximumPageSize (int value)
 
bool GetReverseOrder () const
 
bool ReverseOrderHasBeenSet () const
 
void SetReverseOrder (bool value)
 
PollForDecisionTaskRequestWithReverseOrder (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 PollForDecisionTaskRequest.h.

Constructor & Destructor Documentation

◆ PollForDecisionTaskRequest()

Aws::SWF::Model::PollForDecisionTaskRequest::PollForDecisionTaskRequest ( )

Member Function Documentation

◆ DomainHasBeenSet()

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

The name of the domain containing the task lists to poll.

Definition at line 46 of file PollForDecisionTaskRequest.h.

◆ GetDomain()

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

The name of the domain containing the task lists to poll.

Definition at line 41 of file PollForDecisionTaskRequest.h.

◆ GetIdentity()

const Aws::String& Aws::SWF::Model::PollForDecisionTaskRequest::GetIdentity ( ) const
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 145 of file PollForDecisionTaskRequest.h.

◆ GetMaximumPageSize()

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

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

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Definition at line 340 of file PollForDecisionTaskRequest.h.

◆ GetNextPageToken()

const Aws::String& Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 212 of file PollForDecisionTaskRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SWF::SWFRequest.

◆ GetReverseOrder()

bool Aws::SWF::Model::PollForDecisionTaskRequest::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 372 of file PollForDecisionTaskRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file PollForDecisionTaskRequest.h.

◆ GetTaskList()

const TaskList& Aws::SWF::Model::PollForDecisionTaskRequest::GetTaskList ( ) const
inline

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 87 of file PollForDecisionTaskRequest.h.

◆ IdentityHasBeenSet()

bool Aws::SWF::Model::PollForDecisionTaskRequest::IdentityHasBeenSet ( ) const
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 152 of file PollForDecisionTaskRequest.h.

◆ MaximumPageSizeHasBeenSet()

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

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

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Definition at line 348 of file PollForDecisionTaskRequest.h.

◆ NextPageTokenHasBeenSet()

bool Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 229 of file PollForDecisionTaskRequest.h.

◆ ReverseOrderHasBeenSet()

bool Aws::SWF::Model::PollForDecisionTaskRequest::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 379 of file PollForDecisionTaskRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDomain() [1/3]

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

The name of the domain containing the task lists to poll.

Definition at line 51 of file PollForDecisionTaskRequest.h.

◆ SetDomain() [2/3]

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

The name of the domain containing the task lists to poll.

Definition at line 56 of file PollForDecisionTaskRequest.h.

◆ SetDomain() [3/3]

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

The name of the domain containing the task lists to poll.

Definition at line 61 of file PollForDecisionTaskRequest.h.

◆ SetIdentity() [1/3]

void Aws::SWF::Model::PollForDecisionTaskRequest::SetIdentity ( const Aws::String value)
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 159 of file PollForDecisionTaskRequest.h.

◆ SetIdentity() [2/3]

void Aws::SWF::Model::PollForDecisionTaskRequest::SetIdentity ( Aws::String &&  value)
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 166 of file PollForDecisionTaskRequest.h.

◆ SetIdentity() [3/3]

void Aws::SWF::Model::PollForDecisionTaskRequest::SetIdentity ( const char *  value)
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 173 of file PollForDecisionTaskRequest.h.

◆ SetMaximumPageSize()

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

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

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Definition at line 356 of file PollForDecisionTaskRequest.h.

◆ SetNextPageToken() [1/3]

void Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 246 of file PollForDecisionTaskRequest.h.

◆ SetNextPageToken() [2/3]

void Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 263 of file PollForDecisionTaskRequest.h.

◆ SetNextPageToken() [3/3]

void Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 280 of file PollForDecisionTaskRequest.h.

◆ SetReverseOrder()

void Aws::SWF::Model::PollForDecisionTaskRequest::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 386 of file PollForDecisionTaskRequest.h.

◆ SetTaskList() [1/2]

void Aws::SWF::Model::PollForDecisionTaskRequest::SetTaskList ( const TaskList value)
inline

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 107 of file PollForDecisionTaskRequest.h.

◆ SetTaskList() [2/2]

void Aws::SWF::Model::PollForDecisionTaskRequest::SetTaskList ( TaskList &&  value)
inline

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 117 of file PollForDecisionTaskRequest.h.

◆ TaskListHasBeenSet()

bool Aws::SWF::Model::PollForDecisionTaskRequest::TaskListHasBeenSet ( ) const
inline

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 97 of file PollForDecisionTaskRequest.h.

◆ WithDomain() [1/3]

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

The name of the domain containing the task lists to poll.

Definition at line 66 of file PollForDecisionTaskRequest.h.

◆ WithDomain() [2/3]

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

The name of the domain containing the task lists to poll.

Definition at line 71 of file PollForDecisionTaskRequest.h.

◆ WithDomain() [3/3]

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

The name of the domain containing the task lists to poll.

Definition at line 76 of file PollForDecisionTaskRequest.h.

◆ WithIdentity() [1/3]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::WithIdentity ( const Aws::String value)
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 180 of file PollForDecisionTaskRequest.h.

◆ WithIdentity() [2/3]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::WithIdentity ( Aws::String &&  value)
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 187 of file PollForDecisionTaskRequest.h.

◆ WithIdentity() [3/3]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::WithIdentity ( const char *  value)
inline

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Definition at line 194 of file PollForDecisionTaskRequest.h.

◆ WithMaximumPageSize()

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

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

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Definition at line 364 of file PollForDecisionTaskRequest.h.

◆ WithNextPageToken() [1/3]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 297 of file PollForDecisionTaskRequest.h.

◆ WithNextPageToken() [2/3]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 314 of file PollForDecisionTaskRequest.h.

◆ WithNextPageToken() [3/3]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::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.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Definition at line 331 of file PollForDecisionTaskRequest.h.

◆ WithReverseOrder()

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::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 393 of file PollForDecisionTaskRequest.h.

◆ WithTaskList() [1/2]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::WithTaskList ( const TaskList value)
inline

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 127 of file PollForDecisionTaskRequest.h.

◆ WithTaskList() [2/2]

PollForDecisionTaskRequest& Aws::SWF::Model::PollForDecisionTaskRequest::WithTaskList ( TaskList &&  value)
inline

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -). Also, it must not be the literal string arn.

Definition at line 137 of file PollForDecisionTaskRequest.h.


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