Class GetWorkflowExecutionHistoryRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.swf.model.SwfRequest
software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetWorkflowExecutionHistoryRequest extends SwfRequest implements ToCopyableBuilder<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>

  • Method Details

    • domain

      public final String domain()

      The name of the domain containing the workflow execution.

      Returns:
      The name of the domain containing the workflow execution.

    • execution

      public final WorkflowExecution execution()

      Specifies the workflow execution for which to return the history.

      Returns:
      Specifies the workflow execution for which to return the history.

    • nextPageToken

      public final String nextPageToken()

      If NextPageToken is returned there are more results available. The value of NextPageToken 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 a 400 error: " Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

      Returns:
      If NextPageToken is returned there are more results available. The value of NextPageToken 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 a 400 error: " Specified token has exceeded its maximum lifetime".

      The configured maximumPageSize determines how many results can be returned in a single call.

    • maximumPageSize

      public final Integer maximumPageSize()

      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

      Returns:
      The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    • reverseOrder

      public final Boolean reverseOrder()

      When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

      Returns:
      When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

    • toBuilder

      public GetWorkflowExecutionHistoryRequest.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<GetWorkflowExecutionHistoryRequest.Builder,GetWorkflowExecutionHistoryRequest>
      Specified by:
      toBuilder in class SwfRequest
      Returns:
      a builder for type T

    • builder

      public static GetWorkflowExecutionHistoryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetWorkflowExecutionHistoryRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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