public static interface ListClosedWorkflowExecutionsRequest.Builder extends SwfRequest.Builder, CopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>
Modifier and Type | Method and Description |
---|---|
ListClosedWorkflowExecutionsRequest.Builder |
closeStatusFilter(CloseStatusFilter closeStatusFilter)
If specified, only workflow executions that match this close status are listed.
|
default ListClosedWorkflowExecutionsRequest.Builder |
closeStatusFilter(Consumer<CloseStatusFilter.Builder> closeStatusFilter)
If specified, only workflow executions that match this close status are listed.
|
default ListClosedWorkflowExecutionsRequest.Builder |
closeTimeFilter(Consumer<ExecutionTimeFilter.Builder> 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.Builder |
closeTimeFilter(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.Builder |
domain(String domain)
The name of the domain that contains the workflow executions to list.
|
default ListClosedWorkflowExecutionsRequest.Builder |
executionFilter(Consumer<WorkflowExecutionFilter.Builder> executionFilter)
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
|
ListClosedWorkflowExecutionsRequest.Builder |
executionFilter(WorkflowExecutionFilter executionFilter)
If specified, only workflow executions matching the workflow ID specified in the filter are returned.
|
ListClosedWorkflowExecutionsRequest.Builder |
maximumPageSize(Integer maximumPageSize)
The maximum number of results that are returned per call.
|
ListClosedWorkflowExecutionsRequest.Builder |
nextPageToken(String nextPageToken)
If a
NextPageToken was returned by a previous call, there are more results available. |
ListClosedWorkflowExecutionsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ListClosedWorkflowExecutionsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ListClosedWorkflowExecutionsRequest.Builder |
reverseOrder(Boolean reverseOrder)
When set to
true , returns the results in reverse order. |
default ListClosedWorkflowExecutionsRequest.Builder |
startTimeFilter(Consumer<ExecutionTimeFilter.Builder> 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.Builder |
startTimeFilter(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.
|
default ListClosedWorkflowExecutionsRequest.Builder |
tagFilter(Consumer<TagFilter.Builder> tagFilter)
If specified, only executions that have the matching tag are listed.
|
ListClosedWorkflowExecutionsRequest.Builder |
tagFilter(TagFilter tagFilter)
If specified, only executions that have the matching tag are listed.
|
default ListClosedWorkflowExecutionsRequest.Builder |
typeFilter(Consumer<WorkflowTypeFilter.Builder> typeFilter)
If specified, only executions of the type specified in the filter are returned.
|
ListClosedWorkflowExecutionsRequest.Builder |
typeFilter(WorkflowTypeFilter typeFilter)
If specified, only executions of the type specified in the filter are returned.
|
build
overrideConfiguration
copy
applyMutation, build
ListClosedWorkflowExecutionsRequest.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.ListClosedWorkflowExecutionsRequest.Builder startTimeFilter(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.
default ListClosedWorkflowExecutionsRequest.Builder startTimeFilter(Consumer<ExecutionTimeFilter.Builder> 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.
ExecutionTimeFilter.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)
ListClosedWorkflowExecutionsRequest.Builder closeTimeFilter(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.
default ListClosedWorkflowExecutionsRequest.Builder closeTimeFilter(Consumer<ExecutionTimeFilter.Builder> 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.
ExecutionTimeFilter.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 closeTimeFilter(ExecutionTimeFilter)
.closeTimeFilter
- a consumer that will call methods on ExecutionTimeFilter.Builder
closeTimeFilter(ExecutionTimeFilter)
ListClosedWorkflowExecutionsRequest.Builder executionFilter(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.
default ListClosedWorkflowExecutionsRequest.Builder executionFilter(Consumer<WorkflowExecutionFilter.Builder> 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.
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)
ListClosedWorkflowExecutionsRequest.Builder closeStatusFilter(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.
default ListClosedWorkflowExecutionsRequest.Builder closeStatusFilter(Consumer<CloseStatusFilter.Builder> 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.Builder
avoiding the
need to create one manually via CloseStatusFilter.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to closeStatusFilter(CloseStatusFilter)
.closeStatusFilter
- a consumer that will call methods on CloseStatusFilter.Builder
closeStatusFilter(CloseStatusFilter)
ListClosedWorkflowExecutionsRequest.Builder typeFilter(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.
default ListClosedWorkflowExecutionsRequest.Builder typeFilter(Consumer<WorkflowTypeFilter.Builder> 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.
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)
ListClosedWorkflowExecutionsRequest.Builder tagFilter(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.
default ListClosedWorkflowExecutionsRequest.Builder tagFilter(Consumer<TagFilter.Builder> 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.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)
ListClosedWorkflowExecutionsRequest.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.
ListClosedWorkflowExecutionsRequest.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.
ListClosedWorkflowExecutionsRequest.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 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.ListClosedWorkflowExecutionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ListClosedWorkflowExecutionsRequest.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.