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

Interface ListClosedWorkflowExecutionsRequest.Builder

All Superinterfaces:

CopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>, SdkBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>

Enclosing class:

ListClosedWorkflowExecutionsRequest

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

Method Summary

Modifier and Type	Method	Description
ListClosedWorkflowExecutionsRequest.Builder	closeStatusFilter(CloseStatusFilter closeStatusFilter)	If specified, only workflow executions that match this close status are listed.
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.
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 will be returned per call.
ListClosedWorkflowExecutionsRequest.Builder	nextPageToken(String nextPageToken)	If a NextPageToken was returned by a previous call, there are more results available.
ListClosedWorkflowExecutionsRequest.Builder	reverseOrder(Boolean reverseOrder)	When set to true, returns the results in reverse order.
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.
ListClosedWorkflowExecutionsRequest.Builder	tagFilter(TagFilter tagFilter)	If specified, only executions that have the matching tag are listed.
ListClosedWorkflowExecutionsRequest.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

ListClosedWorkflowExecutionsRequest.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

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.

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 and closeTimeFilter 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

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.

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 and closeTimeFilter 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.

executionFilter

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.

Parameters:

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.

Returns:

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

closeStatusFilter

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.

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 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

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.

Parameters:

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.

Returns:

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

tagFilter

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.

Parameters:

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.

Returns:

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

nextPageToken

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.

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

ListClosedWorkflowExecutionsRequest.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

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.

Parameters:

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.

Returns:

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