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

  • Method Details

    • executionArn

      public final String executionArn()

      The Amazon Resource Name (ARN) of the execution.

      Returns:
      The Amazon Resource Name (ARN) of the execution.

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

    • reverseOrder

      public final Boolean reverseOrder()

      Lists events in descending order of their timeStamp.

      Returns:
      Lists events in descending order of their timeStamp.

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

    • includeExecutionData

      public final Boolean includeExecutionData()

      You can select whether execution data (input or output of a history event) is returned. The default is true.

      Returns:
      You can select whether execution data (input or output of a history event) is returned. The default is true.

    • toBuilder

      public GetExecutionHistoryRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetExecutionHistoryRequest.Builder,GetExecutionHistoryRequest>
      Specified by:
      toBuilder in class SfnRequest

    • builder

      public static GetExecutionHistoryRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo