Class ListOpenWorkflowExecutionsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of the domain that contains the workflow executions to list.If specified, only workflow executions matching the workflow ID specified in the filter are returned.The maximum number of results that will be returned per call.If aNextPageToken
was returned by a previous call, there are more results available.When set totrue
, returns the results in reverse order.Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.If specified, only executions that have the matching tag are listed.If specified, only executions of the type specified in the filter are returned.int
hashCode()
When set totrue
, returns the results in reverse order.void
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 aNextPageToken
was returned by a previous call, there are more results available.void
setReverseOrder
(Boolean reverseOrder) When set totrue
, 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.toString()
Returns a string representation of this object; useful for testing and debugging.withDomain
(String domain) The name of the domain that contains the workflow executions to list.withExecutionFilter
(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the workflow ID specified in the filter are returned.withMaximumPageSize
(Integer maximumPageSize) The maximum number of results that will be returned per call.withNextPageToken
(String nextPageToken) If aNextPageToken
was returned by a previous call, there are more results available.withReverseOrder
(Boolean reverseOrder) When set totrue
, returns the results in reverse order.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.withTagFilter
(TagFilter tagFilter) If specified, only executions that have the matching tag are listed.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, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
ListOpenWorkflowExecutionsRequest
public ListOpenWorkflowExecutionsRequest()
-
-
Method Details
-
setDomain
The name of the domain that contains the workflow executions to list.
- Parameters:
domain
- The name of the domain that contains the workflow executions to list.
-
getDomain
The name of the domain that contains the workflow executions to list.
- Returns:
- The name of the domain that contains the workflow executions to list.
-
withDomain
The name of the domain that contains the workflow executions to list.
- Parameters:
domain
- The name of the domain that contains the workflow executions to list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStartTimeFilter
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.
-
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.
-
withStartTimeFilter
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTypeFilter
If specified, only executions of the type specified in the filter are returned.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
-
getTypeFilter
If specified, only executions of the type specified in the filter are returned.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
-
withTypeFilter
If specified, only executions of the type specified in the filter are returned.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTagFilter
If specified, only executions that have the matching tag are listed.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
-
getTagFilter
If specified, only executions that have the matching tag are listed.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
-
withTagFilter
If specified, only executions that have the matching tag are listed.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- Parameters:
nextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.
-
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- 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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.
-
withNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- Parameters:
nextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaximumPageSize
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.
- 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.
-
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.
- 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.
-
withMaximumPageSize
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setReverseOrder
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 totrue
, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.
-
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.
-
withReverseOrder
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 totrue
, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
setExecutionFilter
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.
-
getExecutionFilter
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter
,typeFilter
andtagFilter
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
andtagFilter
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
andtagFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-