Class IteratorDescription

java.lang.Object
software.amazon.awssdk.services.keyspacesstreams.model.IteratorDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IteratorDescription.Builder,IteratorDescription>
@Generated("software.amazon.awssdk:codegen") public final class IteratorDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IteratorDescription.Builder,IteratorDescription>

Provides information about the current iterator.

See Also:

  • Method Details

    • iteratorPosition

      public final IteratorPosition iteratorPosition()

      Indicates the current iterator's position within the shard. The possible values are:

      • AT_TIP - No more records are currently available.

      • BEHIND_TIP - Additional records may be available.

      Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

      If the service returns an enum value that is not available in the current SDK version, iteratorPosition will return IteratorPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from iteratorPositionAsString().

      Returns:
      Indicates the current iterator's position within the shard. The possible values are:

      • AT_TIP - No more records are currently available.

      • BEHIND_TIP - Additional records may be available.

      Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

      See Also:

    • iteratorPositionAsString

      public final String iteratorPositionAsString()

      Indicates the current iterator's position within the shard. The possible values are:

      • AT_TIP - No more records are currently available.

      • BEHIND_TIP - Additional records may be available.

      Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

      If the service returns an enum value that is not available in the current SDK version, iteratorPosition will return IteratorPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from iteratorPositionAsString().

      Returns:
      Indicates the current iterator's position within the shard. The possible values are:

      • AT_TIP - No more records are currently available.

      • BEHIND_TIP - Additional records may be available.

      Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

      See Also:

    • toBuilder

      public IteratorDescription.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<IteratorDescription.Builder,IteratorDescription>
      Returns:
      a builder for type T

    • builder

      public static IteratorDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IteratorDescription.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.