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

Class ListClosedWorkflowExecutionsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.swf.model.ListClosedWorkflowExecutionsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>

@Generated("software.amazon.awssdk:codegen")
public class ListClosedWorkflowExecutionsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListClosedWorkflowExecutionsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static ListClosedWorkflowExecutionsRequest.Builder	builder()
CloseStatusFilter	closeStatusFilter()	If specified, only workflow executions that match this close status are listed.
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.
String	domain()	The name of the domain that contains the workflow executions to list.
boolean	equals(Object obj)
WorkflowExecutionFilter	executionFilter()	If specified, only workflow executions matching the workflow ID specified in the filter are returned.
int	hashCode()
Integer	maximumPageSize()	The maximum number of results that will be returned per call.
String	nextPageToken()	If a NextPageToken was returned by a previous call, there are more results available.
Boolean	reverseOrder()	When set to true, returns the results in reverse order.
static Class<? extends ListClosedWorkflowExecutionsRequest.Builder>	serializableBuilderClass()
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	tagFilter()	If specified, only executions that have the matching tag are listed.
ListClosedWorkflowExecutionsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
WorkflowTypeFilter	typeFilter()	If specified, only executions of the type specified in the filter are returned.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

domain

public String domain()

The name of the domain that contains the workflow executions to list.

Returns:

The name of the domain that contains the workflow executions to list.

startTimeFilter

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

Returns:

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.

closeTimeFilter

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

Returns:

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.

executionFilter

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

Returns:

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.

closeStatusFilter

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

Returns:

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.

typeFilter

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

Returns:

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.

tagFilter

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

Returns:

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.

nextPageToken

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

Returns:

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.

maximumPageSize

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

Returns:

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.

reverseOrder

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

Returns:

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.

toBuilder

public ListClosedWorkflowExecutionsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>

Returns:

a builder for type T

builder

public static ListClosedWorkflowExecutionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListClosedWorkflowExecutionsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object