Interface ListClosedWorkflowExecutionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,
,ListClosedWorkflowExecutionsRequest> SdkBuilder<ListClosedWorkflowExecutionsRequest.Builder,
,ListClosedWorkflowExecutionsRequest> SdkPojo
,SdkRequest.Builder
,SwfRequest.Builder
- Enclosing class:
ListClosedWorkflowExecutionsRequest
-
Method Summary
Modifier and TypeMethodDescriptioncloseStatusFilter
(Consumer<CloseStatusFilter.Builder> closeStatusFilter) If specified, only workflow executions that match this close status are listed.closeStatusFilter
(CloseStatusFilter closeStatusFilter) If specified, only workflow executions that match this close status are listed.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.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.The name of the domain that contains the workflow executions to list.executionFilter
(Consumer<WorkflowExecutionFilter.Builder> executionFilter) If specified, only workflow executions matching the workflow ID specified in the filter are returned.executionFilter
(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the workflow ID specified in the filter are returned.maximumPageSize
(Integer maximumPageSize) The maximum number of results that are returned per call.nextPageToken
(String nextPageToken) IfNextPageToken
is returned there are more results available.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.reverseOrder
(Boolean reverseOrder) When set totrue
, returns the results in reverse order.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.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.tagFilter
(Consumer<TagFilter.Builder> tagFilter) If specified, only executions that have the matching tag are listed.If specified, only executions that have the matching tag are listed.typeFilter
(Consumer<WorkflowTypeFilter.Builder> typeFilter) If specified, only executions of the type specified in the filter are returned.typeFilter
(WorkflowTypeFilter typeFilter) If specified, only executions of the type specified in the filter are returned.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.swf.model.SwfRequest.Builder
build
-
Method Details
-
domain
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.
-
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.- Parameters:
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTimeFilter
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.ExecutionTimeFilter.Builder
avoiding the need to create one manually viaExecutionTimeFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostartTimeFilter(ExecutionTimeFilter)
.- Parameters:
startTimeFilter
- a consumer that will call methods onExecutionTimeFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.- Parameters:
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
closeTimeFilter
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
andcloseTimeFilter
are mutually exclusive. You must specify one of these in a request but not both.ExecutionTimeFilter.Builder
avoiding the need to create one manually viaExecutionTimeFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloseTimeFilter(ExecutionTimeFilter)
.- Parameters:
closeTimeFilter
- a consumer that will call methods onExecutionTimeFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
executionFilter
ListClosedWorkflowExecutionsRequest.Builder executionFilter(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the workflow ID specified in the filter are returned.
closeStatusFilter
,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.closeStatusFilter
,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.
-
executionFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.WorkflowExecutionFilter.Builder
avoiding the need to create one manually viaWorkflowExecutionFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexecutionFilter(WorkflowExecutionFilter)
.- Parameters:
executionFilter
- a consumer that will call methods onWorkflowExecutionFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.- Parameters:
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
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.
-
closeStatusFilter
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
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.CloseStatusFilter.Builder
avoiding the need to create one manually viaCloseStatusFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloseStatusFilter(CloseStatusFilter)
.- Parameters:
closeStatusFilter
- a consumer that will call methods onCloseStatusFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
typeFilter
If specified, only executions of the type specified in the filter are returned.
closeStatusFilter
,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.closeStatusFilter
,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.
-
typeFilter
default ListClosedWorkflowExecutionsRequest.Builder typeFilter(Consumer<WorkflowTypeFilter.Builder> typeFilter) If specified, only executions of the type specified in the filter are returned.
closeStatusFilter
,executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.WorkflowTypeFilter.Builder
avoiding the need to create one manually viaWorkflowTypeFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totypeFilter(WorkflowTypeFilter)
.- Parameters:
typeFilter
- a consumer that will call methods onWorkflowTypeFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tagFilter
If specified, only executions that have the matching tag are listed.
closeStatusFilter
,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.closeStatusFilter
,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.
-
tagFilter
default ListClosedWorkflowExecutionsRequest.Builder tagFilter(Consumer<TagFilter.Builder> tagFilter) If specified, only executions that have the matching tag are listed.
closeStatusFilter
,executionFilter
,typeFilter
andtagFilter
are mutually exclusive. You can specify at most one of these in a request.TagFilter.Builder
avoiding the need to create one manually viaTagFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagFilter(TagFilter)
.- Parameters:
tagFilter
- a consumer that will call methods onTagFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nextPageToken
If
NextPageToken
is returned there are more results available. The value ofNextPageToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a400
error: "Specified token has exceeded its maximum lifetime
".The configured
maximumPageSize
determines how many results can be returned in a single call.- Parameters:
nextPageToken
- IfNextPageToken
is returned there are more results available. The value ofNextPageToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a400
error: "Specified token has exceeded its maximum lifetime
".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.
-
maximumPageSize
The maximum number of results that are returned per call. Use
nextPageToken
to obtain further pages of results.- Parameters:
maximumPageSize
- The maximum number of results that are returned per call. UsenextPageToken
to obtain further pages of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
reverseOrder
- When set totrue
, 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListClosedWorkflowExecutionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListClosedWorkflowExecutionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-