software.amazon.awssdk.services.sfn.model

Class GetExecutionHistoryRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetExecutionHistoryRequest.Builder,GetExecutionHistoryRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetExecutionHistoryRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetExecutionHistoryRequest.Builder	builder()
boolean	equals(Object obj)
String	executionArn() The Amazon Resource Name (ARN) of the execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
Boolean	reverseOrder() Lists events in descending order of their timeStamp.
List<SdkField<?>>	sdkFields()
static Class<? extends GetExecutionHistoryRequest.Builder>	serializableBuilderClass()
GetExecutionHistoryRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

executionArn

public String executionArn()

The Amazon Resource Name (ARN) of the execution.

Returns:

The Amazon Resource Name (ARN) of the execution.

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.

reverseOrder

public Boolean reverseOrder()

Lists events in descending order of their timeStamp.

Returns:

Lists events in descending order of their timeStamp.

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 60 seconds. 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 60 seconds. Using an expired pagination token will return an HTTP 400 InvalidToken error.

toBuilder

public GetExecutionHistoryRequest.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<GetExecutionHistoryRequest.Builder,GetExecutionHistoryRequest>

Specified by:

toBuilder in class SfnRequest

Returns:

a builder for type T

builder

public static GetExecutionHistoryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetExecutionHistoryRequest.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

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.