Package software.amazon.awssdk.services.swf.model

Interface ListOpenWorkflowExecutionsRequest.Builder

All Superinterfaces:

CopyableBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>, SdkBuilder<ListOpenWorkflowExecutionsRequest.Builder,ListOpenWorkflowExecutionsRequest>

Enclosing class:

ListOpenWorkflowExecutionsRequest

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

Method Summary

Modifier and Type	Method	Description
ListOpenWorkflowExecutionsRequest.Builder	domain(String domain)	The name of the domain that contains the workflow executions to list.
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 will be returned per call.
ListOpenWorkflowExecutionsRequest.Builder	nextPageToken(String nextPageToken)	If a NextPageToken was returned by a previous call, there are more results available.
ListOpenWorkflowExecutionsRequest.Builder	reverseOrder(Boolean reverseOrder)	When set to true, returns the results in reverse order.
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.
ListOpenWorkflowExecutionsRequest.Builder	tagFilter(TagFilter tagFilter)	If specified, only executions that have the matching tag are listed.
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.utils.builder.CopyableBuilder

copy

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

apply, 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.

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.

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.

nextPageToken

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.

Parameters:

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.

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 will be 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.

Parameters:

maximumPageSize - The maximum number of results that will be 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.

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.