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("software.amazon.awssdk:codegen")
public final class ListExecutionsRequest
extends SfnRequest
implements ToCopyableBuilder<ListExecutionsRequest.Builder,ListExecutionsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListExecutionsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListExecutionsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`mapRunArn()`	The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions.
`Integer`	`maxResults()`	The maximum number of results that are returned per call.
`String`	`nextToken()`	If `nextToken` is returned, there are more results available.
`ExecutionRedriveFilter`	`redriveFilter()`	Sets a filter to list executions based on whether or not they have been redriven.
`String`	`redriveFilterAsString()`	Sets a filter to list executions based on whether or not they have been redriven.
`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 final String stateMachineArn()
```
    The Amazon Resource Name (ARN) of the state machine whose executions is listed.
    
    You can specify either a mapRunArn or a stateMachineArn, but not both.
    
    You can also return a list of executions associated with a specific alias or version, by specifying an alias ARN or a version ARN in the stateMachineArn parameter.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the state machine whose executions is listed.
    
    You can specify either a mapRunArn or a stateMachineArn, but not both.
    
    You can also return a list of executions associated with a specific alias or version , by specifying an alias ARN or a version ARN in the stateMachineArn parameter.
  - statusFilter
```
public final 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 final 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 final 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 final 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.
  - mapRunArn
```
public final String mapRunArn()
```
    The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.
    
    You can specify either a mapRunArn or a stateMachineArn, but not both.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the mapRunArn field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see Examining Map Run in the Step Functions Developer Guide.
    
    You can specify either a mapRunArn or a stateMachineArn, but not both.
  - redriveFilter
```
public final ExecutionRedriveFilter redriveFilter()
```
    Sets a filter to list executions based on whether or not they have been redriven.
    
    For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.
    
    If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.
    
    If you provide a state machine ARN in redriveFilter, the API returns a validation exception.
    
    If the service returns an enum value that is not available in the current SDK version, redriveFilter will return ExecutionRedriveFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redriveFilterAsString().
    
    Returns:
    
    Sets a filter to list executions based on whether or not they have been redriven.
    
    For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.
    
    If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.
    
    If you provide a state machine ARN in redriveFilter, the API returns a validation exception.
    
    See Also:
    
    ExecutionRedriveFilter
  - redriveFilterAsString
```
public final String redriveFilterAsString()
```
    Sets a filter to list executions based on whether or not they have been redriven.
    
    For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.
    
    If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.
    
    If you provide a state machine ARN in redriveFilter, the API returns a validation exception.
    
    If the service returns an enum value that is not available in the current SDK version, redriveFilter will return ExecutionRedriveFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redriveFilterAsString().
    
    Returns:
    
    Sets a filter to list executions based on whether or not they have been redriven.
    
    For a Distributed Map, redriveFilter sets a filter to list child workflow executions based on whether or not they have been redriven.
    
    If you do not provide a redriveFilter, Step Functions returns a list of both redriven and non-redriven executions.
    
    If you provide a state machine ARN in redriveFilter, the API returns a validation exception.
    
    See Also:
    
    ExecutionRedriveFilter
  - 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 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

Class ListExecutionsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

stateMachineArn

statusFilter

statusFilterAsString

maxResults

nextToken

mapRunArn

redriveFilter

redriveFilterAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields