software.amazon.awssdk.services.transfer.model

Class ListExecutionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.ListExecutionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListExecutionsRequest.Builder,ListExecutionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListExecutionsRequest
extends TransferRequest
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() Specifies the maximum number of executions to return.
String	nextToken() ListExecutions returns the NextToken parameter in the output.
List<SdkField<?>>	sdkFields()
static Class<? extends ListExecutionsRequest.Builder>	serializableBuilderClass()
ListExecutionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workflowId() A unique identifier for the workflow.

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

maxResults

public final Integer maxResults()

Specifies the maximum number of executions to return.

Returns:

Specifies the maximum number of executions to return.

nextToken

public final String nextToken()

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

Returns:

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, supplying the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.

workflowId

public final String workflowId()

A unique identifier for the workflow.

Returns:

A unique identifier for the workflow.

toBuilder

public ListExecutionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListExecutionsRequest.Builder,ListExecutionsRequest>

Specified by:

toBuilder in class TransferRequest

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