software.amazon.awssdk.services.swf.model

Interface ListOpenWorkflowExecutionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>, SdkBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>, SdkPojo, SdkRequest.Builder, SwfRequest.Builder

Enclosing class:

ListOpenWorkflowExecutionsRequest

public static interface ListOpenWorkflowExecutionsRequest.Builder
extends SwfRequest.Builder, SdkPojo, CopyableBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>

Method Summary

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 NextPageToken is returned there are more results available.
ListOpenWorkflowExecutionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListOpenWorkflowExecutionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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.

Methods inherited from interface software.amazon.awssdk.services.swf.model.SwfRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

domain

ListOpenWorkflowExecutionsRequest.Builder domain(String 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

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.

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.

startTimeFilter

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 the 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).

Parameters:

startTimeFilter - a consumer that will call methods on ExecutionTimeFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

startTimeFilter(ExecutionTimeFilter)

typeFilter

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

typeFilter

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.

This is a convenience that creates an instance of the 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).

Parameters:

typeFilter - a consumer that will call methods on WorkflowTypeFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

typeFilter(WorkflowTypeFilter)

tagFilter

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagFilter

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.

This is a convenience that creates an instance of the 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).

Parameters:

tagFilter - a consumer that will call methods on TagFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tagFilter(TagFilter)

nextPageToken

ListOpenWorkflowExecutionsRequest.Builder nextPageToken(String nextPageToken)

If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

Parameters:

nextPageToken - If NextPageToken is returned there are more results available. The value of NextPageToken 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 60 seconds. Using an expired pagination token will return a 400 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

ListOpenWorkflowExecutionsRequest.Builder maximumPageSize(Integer 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. Use nextPageToken to obtain further pages of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

reverseOrder

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionFilter

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

executionFilter

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.

This is a convenience that creates an instance of the 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).

Parameters:

executionFilter - a consumer that will call methods on WorkflowExecutionFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

executionFilter(WorkflowExecutionFilter)

overrideConfiguration

ListOpenWorkflowExecutionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListOpenWorkflowExecutionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder