Class GetShardIteratorRequest

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

Represents the input for GetShardIterator.

  • Method Details

    • streamName

      public final String streamName()

      The name of the Amazon Kinesis data stream.

      Returns:
      The name of the Amazon Kinesis data stream.

    • shardId

      public final String shardId()

      The shard ID of the Kinesis Data Streams shard to get the iterator for.

      Returns:
      The shard ID of the Kinesis Data Streams shard to get the iterator for.

    • shardIteratorType

      public final ShardIteratorType shardIteratorType()

      Determines how the shard iterator is used to start reading data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

      • LATEST - Start reading 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, shardIteratorType will return ShardIteratorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shardIteratorTypeAsString().

      Returns:
      Determines how the shard iterator is used to start reading data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

      • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

      See Also:

    • shardIteratorTypeAsString

      public final String shardIteratorTypeAsString()

      Determines how the shard iterator is used to start reading data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

      • LATEST - Start reading 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, shardIteratorType will return ShardIteratorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shardIteratorTypeAsString().

      Returns:
      Determines how the shard iterator is used to start reading data records from the shard.

      The following are the valid Amazon Kinesis shard iterator types:

      • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

      • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

      • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

      • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

      See Also:

    • startingSequenceNumber

      public final String startingSequenceNumber()

      The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

      Returns:
      The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

    • timestamp

      public final Instant timestamp()

      The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

      Returns:
      The time stamp of the data record from which to start reading. Used with shard iterator 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, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

    • streamARN

      public final String streamARN()

      The ARN of the stream.

      Returns:
      The ARN of the stream.

    • toBuilder

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

    • builder

      public static GetShardIteratorRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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