software.amazon.awssdk.services.sfn.model

Class ListExecutionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sfn.model.SfnRequest

software.amazon.awssdk.services.sfn.model.ListExecutionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListExecutionsRequest.Builder,ListExecutionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListExecutionsRequest
extends SfnRequest
implements ToCopyableBuilder<ListExecutionsRequest.Builder,ListExecutionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListExecutionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListExecutionsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of results that are returned per call.
String	nextToken() If nextToken is returned, there are more results available.
List<SdkField<?>>	sdkFields()
static Class<? extends ListExecutionsRequest.Builder>	serializableBuilderClass()
String	stateMachineArn() The Amazon Resource Name (ARN) of the state machine whose executions is listed.
ExecutionStatus	statusFilter() If specified, only list the executions whose current execution status matches the given filter.
String	statusFilterAsString() If specified, only list the executions whose current execution status matches the given filter.
ListExecutionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

stateMachineArn

public String stateMachineArn()

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Returns:

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

statusFilter

public ExecutionStatus statusFilter()

If specified, only list the executions whose current execution status matches the given filter.

If the service returns an enum value that is not available in the current SDK version, statusFilter will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusFilterAsString().

Returns:

If specified, only list the executions whose current execution status matches the given filter.

See Also:

ExecutionStatus

statusFilterAsString

public String statusFilterAsString()

If specified, only list the executions whose current execution status matches the given filter.

If the service returns an enum value that is not available in the current SDK version, statusFilter will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusFilterAsString().

Returns:

If specified, only list the executions whose current execution status matches the given filter.

See Also:

ExecutionStatus

maxResults

public Integer maxResults()

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

nextToken

public String nextToken()

If nextToken is returned, there are more results available. The value of nextToken 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 an HTTP 400 InvalidToken error.

Returns:

If nextToken is returned, there are more results available. The value of nextToken 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 an HTTP 400 InvalidToken error.

toBuilder

public ListExecutionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListExecutionsRequest.Builder,ListExecutionsRequest>

Specified by:

toBuilder in class SfnRequest

builder

public static ListExecutionsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo