public static interface ListOpenWorkflowExecutionsRequest.Builder extends SwfRequest.Builder, CopyableBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>
Modifier and Type | Method and Description |
---|---|
ListOpenWorkflowExecutionsRequest.Builder |
domain(String domain)
The name of the domain that contains the workflow executions to list.
|
default ListOpenWorkflowExecutionsRequest.Builder |
executionFilter(Consumer<WorkflowExecutionFilter.Builder> executionFilter)
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
|
ListOpenWorkflowExecutionsRequest.Builder |
executionFilter(WorkflowExecutionFilter executionFilter)
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
|
ListOpenWorkflowExecutionsRequest.Builder |
maximumPageSize(Integer maximumPageSize)
The maximum number of results that are returned per call.
|
ListOpenWorkflowExecutionsRequest.Builder |
nextPageToken(String nextPageToken)
If a
NextPageToken was returned by a previous call, there are more results available. |
ListOpenWorkflowExecutionsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ListOpenWorkflowExecutionsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ListOpenWorkflowExecutionsRequest.Builder |
reverseOrder(Boolean reverseOrder)
When set to
true , returns the results in reverse order. |
default ListOpenWorkflowExecutionsRequest.Builder |
startTimeFilter(Consumer<ExecutionTimeFilter.Builder> startTimeFilter)
Workflow executions are included in the returned results based on whether their start times are within the
range specified by this filter.
|
ListOpenWorkflowExecutionsRequest.Builder |
startTimeFilter(ExecutionTimeFilter startTimeFilter)
Workflow executions are included in the returned results based on whether their start times are within the
range specified by this filter.
|
default ListOpenWorkflowExecutionsRequest.Builder |
tagFilter(Consumer<TagFilter.Builder> tagFilter)
If specified, only executions that have the matching tag are listed.
|
ListOpenWorkflowExecutionsRequest.Builder |
tagFilter(TagFilter tagFilter)
If specified, only executions that have the matching tag are listed.
|
default ListOpenWorkflowExecutionsRequest.Builder |
typeFilter(Consumer<WorkflowTypeFilter.Builder> typeFilter)
If specified, only executions of the type specified in the filter are returned.
|
ListOpenWorkflowExecutionsRequest.Builder |
typeFilter(WorkflowTypeFilter typeFilter)
If specified, only executions of the type specified in the filter are returned.
|
build
overrideConfiguration
copy
applyMutation, build
ListOpenWorkflowExecutionsRequest.Builder domain(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.ListOpenWorkflowExecutionsRequest.Builder startTimeFilter(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.default ListOpenWorkflowExecutionsRequest.Builder startTimeFilter(Consumer<ExecutionTimeFilter.Builder> startTimeFilter)
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
This is a convenience that creates an instance of theExecutionTimeFilter.Builder
avoiding the need
to create one manually via ExecutionTimeFilter.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to startTimeFilter(ExecutionTimeFilter)
.startTimeFilter
- a consumer that will call methods on ExecutionTimeFilter.Builder
startTimeFilter(ExecutionTimeFilter)
ListOpenWorkflowExecutionsRequest.Builder typeFilter(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.
default ListOpenWorkflowExecutionsRequest.Builder typeFilter(Consumer<WorkflowTypeFilter.Builder> 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.
WorkflowTypeFilter.Builder
avoiding the
need to create one manually via WorkflowTypeFilter.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to typeFilter(WorkflowTypeFilter)
.typeFilter
- a consumer that will call methods on WorkflowTypeFilter.Builder
typeFilter(WorkflowTypeFilter)
ListOpenWorkflowExecutionsRequest.Builder tagFilter(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.
default ListOpenWorkflowExecutionsRequest.Builder tagFilter(Consumer<TagFilter.Builder> 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.Builder
avoiding the need to
create one manually via TagFilter.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to tagFilter(TagFilter)
.tagFilter
- a consumer that will call methods on TagFilter.Builder
tagFilter(TagFilter)
ListOpenWorkflowExecutionsRequest.Builder nextPageToken(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.
ListOpenWorkflowExecutionsRequest.Builder maximumPageSize(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.
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.
ListOpenWorkflowExecutionsRequest.Builder reverseOrder(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.ListOpenWorkflowExecutionsRequest.Builder executionFilter(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.
default ListOpenWorkflowExecutionsRequest.Builder executionFilter(Consumer<WorkflowExecutionFilter.Builder> 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.
WorkflowExecutionFilter.Builder
avoiding the need to create one manually via WorkflowExecutionFilter.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately
and its result is passed to executionFilter(WorkflowExecutionFilter)
.executionFilter
- a consumer that will call methods on WorkflowExecutionFilter.Builder
executionFilter(WorkflowExecutionFilter)
ListOpenWorkflowExecutionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ListOpenWorkflowExecutionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.