@Generated(value="software.amazon.awssdk:codegen") public final class ListOpenWorkflowExecutionsRequest extends SwfRequest implements ToCopyableBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
ListOpenWorkflowExecutionsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static ListOpenWorkflowExecutionsRequest.Builder |
builder() |
String |
domain()
The name of the domain that contains the workflow executions to list.
|
boolean |
equals(Object obj) |
WorkflowExecutionFilter |
executionFilter()
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
maximumPageSize()
The maximum number of results that are returned per call.
|
String |
nextPageToken()
If a
NextPageToken was returned by a previous call, there are more results available. |
Boolean |
reverseOrder()
When set to
true , returns the results in reverse order. |
static Class<? extends ListOpenWorkflowExecutionsRequest.Builder> |
serializableBuilderClass() |
ExecutionTimeFilter |
startTimeFilter()
Workflow executions are included in the returned results based on whether their start times are within the range
specified by this filter.
|
TagFilter |
tagFilter()
If specified, only executions that have the matching tag are listed.
|
ListOpenWorkflowExecutionsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
WorkflowTypeFilter |
typeFilter()
If specified, only executions of the type specified in the filter are returned.
|
overrideConfiguration
copy
public String domain()
The name of the domain that contains the workflow executions to list.
public ExecutionTimeFilter startTimeFilter()
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
public 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.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
public 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.
executionFilter
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
public 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
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 maximumPageSize()
The maximum number of results that are 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 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.
true
, returns the results in reverse order. By default the results are returned
in descending order of the start time of the executions.public 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
, typeFilter
and tagFilter
are mutually exclusive.
You can specify at most one of these in a request.
public ListOpenWorkflowExecutionsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>
toBuilder
in class SwfRequest
public static ListOpenWorkflowExecutionsRequest.Builder builder()
public static Class<? extends ListOpenWorkflowExecutionsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.