public class ListClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private CloseStatusFilter |
closeStatusFilter
If specified, only workflow executions that match this close
status are listed.
|
private 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.
|
private java.lang.String |
domain
The name of the domain that contains the workflow executions to list.
|
private WorkflowExecutionFilter |
executionFilter
If specified, only workflow executions matching the workflow ID specified
in the filter are returned.
|
private java.lang.Integer |
maximumPageSize
The maximum number of results that will be returned per call.
|
private java.lang.String |
nextPageToken
If a
NextPageToken was returned by a previous call, there
are more results available. |
private java.lang.Boolean |
reverseOrder
When set to
true , returns the results in reverse order. |
private 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.
|
private TagFilter |
tagFilter
If specified, only executions that have the matching tag are listed.
|
private WorkflowTypeFilter |
typeFilter
If specified, only executions of the type specified in the filter are
returned.
|
NOOP
Constructor and Description |
---|
ListClosedWorkflowExecutionsRequest() |
Modifier and Type | Method and Description |
---|---|
ListClosedWorkflowExecutionsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.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.
|
java.lang.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.
|
java.lang.Integer |
getMaximumPageSize()
The maximum number of results that will be returned per call.
|
java.lang.String |
getNextPageToken()
If a
NextPageToken was returned by a previous call, there
are more results available. |
java.lang.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() |
java.lang.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(java.lang.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(java.lang.Integer maximumPageSize)
The maximum number of results that will be returned per call.
|
void |
setNextPageToken(java.lang.String nextPageToken)
If a
NextPageToken was returned by a previous call, there
are more results available. |
void |
setReverseOrder(java.lang.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.
|
java.lang.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(java.lang.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(java.lang.Integer maximumPageSize)
The maximum number of results that will be returned per call.
|
ListClosedWorkflowExecutionsRequest |
withNextPageToken(java.lang.String nextPageToken)
If a
NextPageToken was returned by a previous call, there
are more results available. |
ListClosedWorkflowExecutionsRequest |
withReverseOrder(java.lang.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.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String domain
The name of the domain that contains the workflow executions to list.
private 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. 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.private 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. 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.private WorkflowExecutionFilter 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.private CloseStatusFilter 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.private WorkflowTypeFilter 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.private TagFilter 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.private java.lang.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.
private java.lang.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.
private java.lang.Boolean 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 void setDomain(java.lang.String domain)
The name of the domain that contains the workflow executions to list.
domain
- The name of the domain that contains the workflow executions to
list.public java.lang.String getDomain()
The name of the domain that contains the workflow executions to list.
public ListClosedWorkflowExecutionsRequest withDomain(java.lang.String domain)
The name of the domain that contains the workflow executions to list.
domain
- The name of the domain that contains the workflow executions to
list.public 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. 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.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 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. 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.startTimeFilter
and
closeTimeFilter
are mutually exclusive. You must
specify one of these in a request but not both.public 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. 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.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 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. 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.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 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. 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.startTimeFilter
and
closeTimeFilter
are mutually exclusive. You must
specify one of these in a request but not both.public 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. 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.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 void setExecutionFilter(WorkflowExecutionFilter 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.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 WorkflowExecutionFilter getExecutionFilter()
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.closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.public ListClosedWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter 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.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 void setCloseStatusFilter(CloseStatusFilter 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.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 CloseStatusFilter getCloseStatusFilter()
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.closeStatusFilter
, executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.public ListClosedWorkflowExecutionsRequest withCloseStatusFilter(CloseStatusFilter 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.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 void setTypeFilter(WorkflowTypeFilter 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.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 WorkflowTypeFilter getTypeFilter()
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.closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at
most one of these in a request.public ListClosedWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter 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.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 void setTagFilter(TagFilter 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.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 TagFilter getTagFilter()
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.closeStatusFilter
,
executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at
most one of these in a request.public ListClosedWorkflowExecutionsRequest withTagFilter(TagFilter 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.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 void setNextPageToken(java.lang.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.
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 java.lang.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.
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(java.lang.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.
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 void setMaximumPageSize(java.lang.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.
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 java.lang.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.
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(java.lang.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.
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 void setReverseOrder(java.lang.Boolean 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.
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 java.lang.Boolean getReverseOrder()
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.
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(java.lang.Boolean 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.
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 java.lang.Boolean isReverseOrder()
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.
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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public ListClosedWorkflowExecutionsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()