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

Class ListClosedWorkflowExecutionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.swf.model.SwfRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListClosedWorkflowExecutionsRequest.Builder

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)
boolean	equalsBySdkFields(Object obj)
WorkflowExecutionFilter	executionFilter()	If specified, only workflow executions matching the workflow ID specified in the filter are returned.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maximumPageSize()	The maximum number of results that are returned per call.
String	nextPageToken()	If NextPageToken is returned there are more results available.
Boolean	reverseOrder()	When set to true, returns the results in reverse order.
List<SdkField<?>>	sdkFields()
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()
String	toString()	Returns a string representation of this object.
WorkflowTypeFilter	typeFilter()	If specified, only executions of the type specified in the filter are returned.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domain

public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 24 hours. 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:

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 24 hours. 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.

maximumPageSize

public final Integer maximumPageSize()

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Returns:

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

reverseOrder

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<ListClosedWorkflowExecutionsRequest.Builder,ListClosedWorkflowExecutionsRequest>

Specified by:

toBuilder in class SwfRequest

builder

public static ListClosedWorkflowExecutionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo