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

#include <ListClosedWorkflowExecutionsRequest.h>

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

Public Member Functions

 ListClosedWorkflowExecutionsRequest ()
 
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)
 
ListClosedWorkflowExecutionsRequestWithDomain (const Aws::String &value)
 
ListClosedWorkflowExecutionsRequestWithDomain (Aws::String &&value)
 
ListClosedWorkflowExecutionsRequestWithDomain (const char *value)
 
const ExecutionTimeFilterGetStartTimeFilter () const
 
bool StartTimeFilterHasBeenSet () const
 
void SetStartTimeFilter (const ExecutionTimeFilter &value)
 
void SetStartTimeFilter (ExecutionTimeFilter &&value)
 
ListClosedWorkflowExecutionsRequestWithStartTimeFilter (const ExecutionTimeFilter &value)
 
ListClosedWorkflowExecutionsRequestWithStartTimeFilter (ExecutionTimeFilter &&value)
 
const ExecutionTimeFilterGetCloseTimeFilter () const
 
bool CloseTimeFilterHasBeenSet () const
 
void SetCloseTimeFilter (const ExecutionTimeFilter &value)
 
void SetCloseTimeFilter (ExecutionTimeFilter &&value)
 
ListClosedWorkflowExecutionsRequestWithCloseTimeFilter (const ExecutionTimeFilter &value)
 
ListClosedWorkflowExecutionsRequestWithCloseTimeFilter (ExecutionTimeFilter &&value)
 
const WorkflowExecutionFilterGetExecutionFilter () const
 
bool ExecutionFilterHasBeenSet () const
 
void SetExecutionFilter (const WorkflowExecutionFilter &value)
 
void SetExecutionFilter (WorkflowExecutionFilter &&value)
 
ListClosedWorkflowExecutionsRequestWithExecutionFilter (const WorkflowExecutionFilter &value)
 
ListClosedWorkflowExecutionsRequestWithExecutionFilter (WorkflowExecutionFilter &&value)
 
const CloseStatusFilterGetCloseStatusFilter () const
 
bool CloseStatusFilterHasBeenSet () const
 
void SetCloseStatusFilter (const CloseStatusFilter &value)
 
void SetCloseStatusFilter (CloseStatusFilter &&value)
 
ListClosedWorkflowExecutionsRequestWithCloseStatusFilter (const CloseStatusFilter &value)
 
ListClosedWorkflowExecutionsRequestWithCloseStatusFilter (CloseStatusFilter &&value)
 
const WorkflowTypeFilterGetTypeFilter () const
 
bool TypeFilterHasBeenSet () const
 
void SetTypeFilter (const WorkflowTypeFilter &value)
 
void SetTypeFilter (WorkflowTypeFilter &&value)
 
ListClosedWorkflowExecutionsRequestWithTypeFilter (const WorkflowTypeFilter &value)
 
ListClosedWorkflowExecutionsRequestWithTypeFilter (WorkflowTypeFilter &&value)
 
const TagFilterGetTagFilter () const
 
bool TagFilterHasBeenSet () const
 
void SetTagFilter (const TagFilter &value)
 
void SetTagFilter (TagFilter &&value)
 
ListClosedWorkflowExecutionsRequestWithTagFilter (const TagFilter &value)
 
ListClosedWorkflowExecutionsRequestWithTagFilter (TagFilter &&value)
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
ListClosedWorkflowExecutionsRequestWithNextPageToken (const Aws::String &value)
 
ListClosedWorkflowExecutionsRequestWithNextPageToken (Aws::String &&value)
 
ListClosedWorkflowExecutionsRequestWithNextPageToken (const char *value)
 
int GetMaximumPageSize () const
 
bool MaximumPageSizeHasBeenSet () const
 
void SetMaximumPageSize (int value)
 
ListClosedWorkflowExecutionsRequestWithMaximumPageSize (int value)
 
bool GetReverseOrder () const
 
bool ReverseOrderHasBeenSet () const
 
void SetReverseOrder (bool value)
 
ListClosedWorkflowExecutionsRequestWithReverseOrder (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 26 of file ListClosedWorkflowExecutionsRequest.h.

Constructor & Destructor Documentation

◆ ListClosedWorkflowExecutionsRequest()

Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::ListClosedWorkflowExecutionsRequest ( )

Member Function Documentation

◆ CloseStatusFilterHasBeenSet()

bool Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::CloseStatusFilterHasBeenSet ( ) const
inline

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 278 of file ListClosedWorkflowExecutionsRequest.h.

◆ CloseTimeFilterHasBeenSet()

bool Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::CloseTimeFilterHasBeenSet ( ) const
inline

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 162 of file ListClosedWorkflowExecutionsRequest.h.

◆ DomainHasBeenSet()

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

The name of the domain that contains the workflow executions to list.

Definition at line 50 of file ListClosedWorkflowExecutionsRequest.h.

◆ ExecutionFilterHasBeenSet()

bool Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::ExecutionFilterHasBeenSet ( ) const
inline

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 221 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetCloseStatusFilter()

const CloseStatusFilter& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::GetCloseStatusFilter ( ) const
inline

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 268 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetCloseTimeFilter()

const ExecutionTimeFilter& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::GetCloseTimeFilter ( ) const
inline

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 152 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetDomain()

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

The name of the domain that contains the workflow executions to list.

Definition at line 45 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetExecutionFilter()

const WorkflowExecutionFilter& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::GetExecutionFilter ( ) const
inline

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 212 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetMaximumPageSize()

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

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

Definition at line 526 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetNextPageToken()

const Aws::String& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::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 435 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SWF::SWFRequest.

◆ GetReverseOrder()

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

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Definition at line 552 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetServiceRequestName()

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

◆ GetStartTimeFilter()

const ExecutionTimeFilter& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::GetStartTimeFilter ( ) const
inline

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 91 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetTagFilter()

const TagFilter& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::GetTagFilter ( ) const
inline

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 382 of file ListClosedWorkflowExecutionsRequest.h.

◆ GetTypeFilter()

const WorkflowTypeFilter& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::GetTypeFilter ( ) const
inline

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 328 of file ListClosedWorkflowExecutionsRequest.h.

◆ MaximumPageSizeHasBeenSet()

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

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

Definition at line 532 of file ListClosedWorkflowExecutionsRequest.h.

◆ NextPageTokenHasBeenSet()

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

◆ ReverseOrderHasBeenSet()

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

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Definition at line 559 of file ListClosedWorkflowExecutionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCloseStatusFilter() [1/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetCloseStatusFilter ( const CloseStatusFilter value)
inline

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 288 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetCloseStatusFilter() [2/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetCloseStatusFilter ( CloseStatusFilter &&  value)
inline

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 298 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetCloseTimeFilter() [1/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetCloseTimeFilter ( const ExecutionTimeFilter value)
inline

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 172 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetCloseTimeFilter() [2/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetCloseTimeFilter ( ExecutionTimeFilter &&  value)
inline

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 182 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetDomain() [1/3]

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

The name of the domain that contains the workflow executions to list.

Definition at line 55 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetDomain() [2/3]

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

The name of the domain that contains the workflow executions to list.

Definition at line 60 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetDomain() [3/3]

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

The name of the domain that contains the workflow executions to list.

Definition at line 65 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetExecutionFilter() [1/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetExecutionFilter ( const WorkflowExecutionFilter value)
inline

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 230 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetExecutionFilter() [2/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetExecutionFilter ( WorkflowExecutionFilter &&  value)
inline

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 239 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetMaximumPageSize()

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

◆ SetNextPageToken() [1/3]

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

◆ SetNextPageToken() [2/3]

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

◆ SetNextPageToken() [3/3]

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

◆ SetReverseOrder()

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

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Definition at line 566 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetStartTimeFilter() [1/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetStartTimeFilter ( const ExecutionTimeFilter value)
inline

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 111 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetStartTimeFilter() [2/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetStartTimeFilter ( ExecutionTimeFilter &&  value)
inline

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 121 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetTagFilter() [1/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetTagFilter ( const TagFilter value)
inline

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 398 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetTagFilter() [2/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetTagFilter ( TagFilter &&  value)
inline

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 406 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetTypeFilter() [1/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetTypeFilter ( const WorkflowTypeFilter value)
inline

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 346 of file ListClosedWorkflowExecutionsRequest.h.

◆ SetTypeFilter() [2/2]

void Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::SetTypeFilter ( WorkflowTypeFilter &&  value)
inline

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 355 of file ListClosedWorkflowExecutionsRequest.h.

◆ StartTimeFilterHasBeenSet()

bool Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::StartTimeFilterHasBeenSet ( ) const
inline

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 101 of file ListClosedWorkflowExecutionsRequest.h.

◆ TagFilterHasBeenSet()

bool Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::TagFilterHasBeenSet ( ) const
inline

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 390 of file ListClosedWorkflowExecutionsRequest.h.

◆ TypeFilterHasBeenSet()

bool Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::TypeFilterHasBeenSet ( ) const
inline

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 337 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithCloseStatusFilter() [1/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithCloseStatusFilter ( const CloseStatusFilter value)
inline

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 308 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithCloseStatusFilter() [2/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithCloseStatusFilter ( CloseStatusFilter &&  value)
inline

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 318 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithCloseTimeFilter() [1/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithCloseTimeFilter ( const ExecutionTimeFilter value)
inline

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 192 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithCloseTimeFilter() [2/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithCloseTimeFilter ( ExecutionTimeFilter &&  value)
inline

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 202 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithDomain() [1/3]

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

The name of the domain that contains the workflow executions to list.

Definition at line 70 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithDomain() [2/3]

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

The name of the domain that contains the workflow executions to list.

Definition at line 75 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithDomain() [3/3]

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

The name of the domain that contains the workflow executions to list.

Definition at line 80 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithExecutionFilter() [1/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithExecutionFilter ( const WorkflowExecutionFilter value)
inline

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 248 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithExecutionFilter() [2/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithExecutionFilter ( WorkflowExecutionFilter &&  value)
inline

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 257 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithMaximumPageSize()

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

◆ WithNextPageToken() [1/3]

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

◆ WithNextPageToken() [2/3]

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

◆ WithNextPageToken() [3/3]

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

◆ WithReverseOrder()

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

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Definition at line 573 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithStartTimeFilter() [1/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithStartTimeFilter ( const ExecutionTimeFilter value)
inline

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 131 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithStartTimeFilter() [2/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithStartTimeFilter ( ExecutionTimeFilter &&  value)
inline

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Definition at line 141 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithTagFilter() [1/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithTagFilter ( const TagFilter value)
inline

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 414 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithTagFilter() [2/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithTagFilter ( TagFilter &&  value)
inline

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 422 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithTypeFilter() [1/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithTypeFilter ( const WorkflowTypeFilter value)
inline

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 364 of file ListClosedWorkflowExecutionsRequest.h.

◆ WithTypeFilter() [2/2]

ListClosedWorkflowExecutionsRequest& Aws::SWF::Model::ListClosedWorkflowExecutionsRequest::WithTypeFilter ( WorkflowTypeFilter &&  value)
inline

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Definition at line 373 of file ListClosedWorkflowExecutionsRequest.h.


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