public class ListOpenWorkflowExecutionsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
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
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 |
---|
ListOpenWorkflowExecutionsRequest() |
Modifier and Type | Method and Description |
---|---|
ListOpenWorkflowExecutionsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
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()
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 |
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)
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.
|
ListOpenWorkflowExecutionsRequest |
withDomain(java.lang.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(java.lang.Integer maximumPageSize)
The maximum number of results that will be returned per call.
|
ListOpenWorkflowExecutionsRequest |
withNextPageToken(java.lang.String nextPageToken)
If a
NextPageToken was returned by a previous call, there
are more results available. |
ListOpenWorkflowExecutionsRequest |
withReverseOrder(java.lang.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.
|
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
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
private 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.private 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.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 time of
the executions.
private 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.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 ListOpenWorkflowExecutionsRequest 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)
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
startTimeFilter
- Workflow executions are included in the returned results based on
whether their start times are within the range specified by this
filter.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.
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.
startTimeFilter
- Workflow executions are included in the returned results based on
whether their start times are within the range specified by this
filter.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.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.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.executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.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.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.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.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.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.executionFilter
,
typeFilter
and tagFilter
are mutually
exclusive. You can specify at most one of these in a request.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.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.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 ListOpenWorkflowExecutionsRequest 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 ListOpenWorkflowExecutionsRequest 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 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 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 time of
the executions.
true
, returns the results in reverse
order. By default the results are returned in descending order of
the start time of the executions.public ListOpenWorkflowExecutionsRequest 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 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 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 time of
the executions.
true
, returns the results in reverse
order. By default the results are returned in descending order of
the start time of the executions.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.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.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.executionFilter
, typeFilter
and
tagFilter
are mutually exclusive. You can specify at
most one of these in a request.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.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.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 ListOpenWorkflowExecutionsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()