public class ListClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
ListClosedWorkflowExecutions operation
.
Returns a list of closed 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:
Resource
element with the domain name to limit
the action to only specified domains.Action
element to allow or deny permission to
call this action.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 .
NOOP
Constructor and Description |
---|
ListClosedWorkflowExecutionsRequest() |
Modifier and Type | Method and Description |
---|---|
ListClosedWorkflowExecutionsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
CloseStatusFilter |
getCloseStatusFilter()
If specified, only workflow executions that match this close
status are listed.
|
ExecutionTimeFilter |
getCloseTimeFilter()
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.
|
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()
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.
|
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 |
setCloseStatusFilter(CloseStatusFilter closeStatusFilter)
If specified, only workflow executions that match this close
status are listed.
|
void |
setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)
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.
|
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)
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.
|
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.
|
ListClosedWorkflowExecutionsRequest |
withCloseStatusFilter(CloseStatusFilter closeStatusFilter)
If specified, only workflow executions that match this close
status are listed.
|
ListClosedWorkflowExecutionsRequest |
withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)
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.
|
ListClosedWorkflowExecutionsRequest |
withDomain(String domain)
The name of the domain that contains the workflow executions to list.
|
ListClosedWorkflowExecutionsRequest |
withExecutionFilter(WorkflowExecutionFilter executionFilter)
If specified, only workflow executions matching the workflow ID
specified in the filter are returned.
|
ListClosedWorkflowExecutionsRequest |
withMaximumPageSize(Integer maximumPageSize)
The maximum number of results that will be returned per call.
|
ListClosedWorkflowExecutionsRequest |
withNextPageToken(String nextPageToken)
If a
NextPageToken was returned by a previous call, there
are more results available. |
ListClosedWorkflowExecutionsRequest |
withReverseOrder(Boolean reverseOrder)
When set to
true , returns the results in reverse order. |
ListClosedWorkflowExecutionsRequest |
withStartTimeFilter(ExecutionTimeFilter startTimeFilter)
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.
|
ListClosedWorkflowExecutionsRequest |
withTagFilter(TagFilter tagFilter)
If specified, only executions that have the matching tag are listed.
|
ListClosedWorkflowExecutionsRequest |
withTypeFilter(WorkflowTypeFilter typeFilter)
If specified, only executions of the type specified in the filter are
returned.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(String domain)
Constraints:
Length: 1 - 256
domain
- The name of the domain that contains the workflow executions to list.public ListClosedWorkflowExecutionsRequest withDomain(String domain)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
domain
- The name of the domain that contains the workflow executions to list.public ExecutionTimeFilter getStartTimeFilter()
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter)
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.startTimeFilter
- 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.public ListClosedWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter)
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.Returns a reference to this object so that method calls can be chained together.
startTimeFilter
- 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.public ExecutionTimeFilter getCloseTimeFilter()
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.public void setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.closeTimeFilter
- 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.public ListClosedWorkflowExecutionsRequest withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)
startTimeFilter
and closeTimeFilter
are mutually exclusive. You must specify one of these in a request but
not both.Returns a reference to this object so that method calls can be chained together.
closeTimeFilter
- 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.public WorkflowExecutionFilter getExecutionFilter()
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.public void setExecutionFilter(WorkflowExecutionFilter executionFilter)
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.executionFilter
- 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.public ListClosedWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter)
closeStatusFilter
, 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.
executionFilter
- 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.public CloseStatusFilter getCloseStatusFilter()
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.public void setCloseStatusFilter(CloseStatusFilter closeStatusFilter)
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.closeStatusFilter
- 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.public ListClosedWorkflowExecutionsRequest withCloseStatusFilter(CloseStatusFilter closeStatusFilter)
closeStatusFilter
, 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.
closeStatusFilter
- 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.public WorkflowTypeFilter getTypeFilter()
closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.public void setTypeFilter(WorkflowTypeFilter typeFilter)
closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at most
one of these in a request.typeFilter
- 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.public ListClosedWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter)
closeStatusFilter
,
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.
typeFilter
- 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.public TagFilter getTagFilter()
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.public void setTagFilter(TagFilter tagFilter)
closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.tagFilter
- 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.public ListClosedWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter)
closeStatusFilter
, 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.
tagFilter
- 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.public String getNextPageToken()
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
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.
public void setNextPageToken(String nextPageToken)
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
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.
public ListClosedWorkflowExecutionsRequest withNextPageToken(String nextPageToken)
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
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.
public Integer getMaximumPageSize()
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
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.
public void setMaximumPageSize(Integer maximumPageSize)
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
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.
public ListClosedWorkflowExecutionsRequest withMaximumPageSize(Integer maximumPageSize)
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
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.
public Boolean isReverseOrder()
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.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.public void setReverseOrder(Boolean reverseOrder)
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.reverseOrder
- 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.public ListClosedWorkflowExecutionsRequest withReverseOrder(Boolean reverseOrder)
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.
Returns a reference to this object so that method calls can be chained together.
reverseOrder
- 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.public Boolean getReverseOrder()
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.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.public String toString()
toString
in class Object
Object.toString()
public ListClosedWorkflowExecutionsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.