Class StartingPosition

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

The starting position in the data stream from which to start streaming.

See Also:

  • Method Details

    • type

      public final ShardIteratorType type()

      You can set the starting position to one of the following values:

      AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.

      AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

      AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.

      TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

      LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.

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

      Returns:
      You can set the starting position to one of the following values:

      AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.

      AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

      AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.

      TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

      LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.

      See Also:

    • typeAsString

      public final String typeAsString()

      You can set the starting position to one of the following values:

      AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.

      AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

      AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.

      TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

      LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.

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

      Returns:
      You can set the starting position to one of the following values:

      AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.

      AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.

      AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.

      TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

      LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.

      See Also:

    • sequenceNumber

      public final String sequenceNumber()

      The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

      Returns:
      The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.

    • timestamp

      public final Instant timestamp()

      The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480 . If a record with this exact time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON).

      Returns:
      The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to Type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record (TRIM_HORIZON).

    • toBuilder

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

    • builder

      public static StartingPosition.Builder builder()

    • serializableBuilderClass

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