com.amazonaws.services.simpleworkflow.model

Class ListOpenWorkflowExecutionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.ListOpenWorkflowExecutionsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListOpenWorkflowExecutionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ListOpenWorkflowExecutions operation.

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

NOTE: This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • tagFilter.tag : String constraint. The key is swf:tagFilter.tag .
  • typeFilter.name : String constraint. The key is swf:typeFilter.name .
  • typeFilter.version : String constraint. The key is swf:typeFilter.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListOpenWorkflowExecutionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ListOpenWorkflowExecutionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDomain() The name of the domain that contains the workflow executions to list.
WorkflowExecutionFilter	getExecutionFilter() If specified, only workflow executions matching the workflow ID specified in the filter are returned.
Integer	getMaximumPageSize() The maximum number of results that will be returned per call.
String	getNextPageToken() If a NextPageToken was returned by a previous call, there are more results available.
Boolean	getReverseOrder() When set to true, returns the results in reverse order.
ExecutionTimeFilter	getStartTimeFilter() Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
TagFilter	getTagFilter() If specified, only executions that have the matching tag are listed.
WorkflowTypeFilter	getTypeFilter() If specified, only executions of the type specified in the filter are returned.
int	hashCode()
Boolean	isReverseOrder() When set to true, returns the results in reverse order.
void	setDomain(String domain) The name of the domain that contains the workflow executions to list.
void	setExecutionFilter(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the workflow ID specified in the filter are returned.
void	setMaximumPageSize(Integer maximumPageSize) The maximum number of results that will be returned per call.
void	setNextPageToken(String nextPageToken) If a NextPageToken was returned by a previous call, there are more results available.
void	setReverseOrder(Boolean reverseOrder) When set to true, returns the results in reverse order.
void	setStartTimeFilter(ExecutionTimeFilter startTimeFilter) Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
void	setTagFilter(TagFilter tagFilter) If specified, only executions that have the matching tag are listed.
void	setTypeFilter(WorkflowTypeFilter typeFilter) If specified, only executions of the type specified in the filter are returned.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListOpenWorkflowExecutionsRequest	withDomain(String domain) The name of the domain that contains the workflow executions to list.
ListOpenWorkflowExecutionsRequest	withExecutionFilter(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the workflow ID specified in the filter are returned.
ListOpenWorkflowExecutionsRequest	withMaximumPageSize(Integer maximumPageSize) The maximum number of results that will be returned per call.
ListOpenWorkflowExecutionsRequest	withNextPageToken(String nextPageToken) If a NextPageToken was returned by a previous call, there are more results available.
ListOpenWorkflowExecutionsRequest	withReverseOrder(Boolean reverseOrder) When set to true, returns the results in reverse order.
ListOpenWorkflowExecutionsRequest	withStartTimeFilter(ExecutionTimeFilter startTimeFilter) Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
ListOpenWorkflowExecutionsRequest	withTagFilter(TagFilter tagFilter) If specified, only executions that have the matching tag are listed.
ListOpenWorkflowExecutionsRequest	withTypeFilter(WorkflowTypeFilter typeFilter) If specified, only executions of the type specified in the filter are returned.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListOpenWorkflowExecutionsRequest

public ListOpenWorkflowExecutionsRequest()

Method Detail

getDomain

public String getDomain()

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

Constraints:
Length: 1 - 256

Returns:

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

setDomain

public void setDomain(String domain)

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

Constraints:
Length: 1 - 256

Parameters:

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

withDomain

public ListOpenWorkflowExecutionsRequest withDomain(String domain)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getStartTimeFilter

public ExecutionTimeFilter getStartTimeFilter()

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

Returns:

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

setStartTimeFilter

public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter)

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

Parameters:

startTimeFilter - Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

withStartTimeFilter

public ListOpenWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter)

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

Returns a reference to this object so that method calls can be chained together.

Parameters:

startTimeFilter - Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

Returns:

A reference to this updated object so that method calls can be chained together.

getTypeFilter

public WorkflowTypeFilter getTypeFilter()

If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

setTypeFilter

public void setTypeFilter(WorkflowTypeFilter typeFilter)

If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Parameters:

typeFilter - If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withTypeFilter

public ListOpenWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter)

If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

typeFilter - If specified, only executions of the type specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

A reference to this updated object so that method calls can be chained together.

getTagFilter

public TagFilter getTagFilter()

If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

setTagFilter

public void setTagFilter(TagFilter tagFilter)

If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Parameters:

tagFilter - If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withTagFilter

public ListOpenWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter)

If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tagFilter - If specified, only executions that have the matching tag are listed. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextPageToken

public String getNextPageToken()

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

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

Constraints:
Length: 0 - 2048

Returns:

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

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

setNextPageToken

public void setNextPageToken(String nextPageToken)

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

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

Constraints:
Length: 0 - 2048

Parameters:

nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

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

withNextPageToken

public ListOpenWorkflowExecutionsRequest withNextPageToken(String nextPageToken)

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 2048

Parameters:

nextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaximumPageSize

public Integer getMaximumPageSize()

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

Constraints:
Range: 0 - 1000

Returns:

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

setMaximumPageSize

public void setMaximumPageSize(Integer maximumPageSize)

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

Constraints:
Range: 0 - 1000

Parameters:

maximumPageSize - The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

withMaximumPageSize

public ListOpenWorkflowExecutionsRequest withMaximumPageSize(Integer maximumPageSize)

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 - 1000

Parameters:

maximumPageSize - The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

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

Returns:

A reference to this updated object so that method calls can be chained together.

isReverseOrder

public Boolean isReverseOrder()

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

Returns:

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

setReverseOrder

public void setReverseOrder(Boolean reverseOrder)

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

Parameters:

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

withReverseOrder

public ListOpenWorkflowExecutionsRequest withReverseOrder(Boolean reverseOrder)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getReverseOrder

public Boolean getReverseOrder()

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

Returns:

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

getExecutionFilter

public WorkflowExecutionFilter getExecutionFilter()

If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

setExecutionFilter

public void setExecutionFilter(WorkflowExecutionFilter executionFilter)

If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Parameters:

executionFilter - If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withExecutionFilter

public ListOpenWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter)

If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

executionFilter - If specified, only workflow executions matching the workflow ID specified in the filter are returned. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public ListOpenWorkflowExecutionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()