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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetShardIteratorRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetShardIteratorRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetShardIteratorRequest.Builder>`	`serializableBuilderClass()`
`String`	`shardId()`	The shard ID of the Kinesis Data Streams shard to get the iterator for.
`ShardIteratorType`	`shardIteratorType()`	Determines how the shard iterator is used to start reading data records from the shard.
`String`	`shardIteratorTypeAsString()`	Determines how the shard iterator is used to start reading data records from the shard.
`String`	`startingSequenceNumber()`	The sequence number of the data record in the shard from which to start reading.
`String`	`streamARN()`	The ARN of the stream.
`String`	`streamName()`	The name of the Amazon Kinesis data stream.
`Instant`	`timestamp()`	The time stamp of the data record from which to start reading.
`GetShardIteratorRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    ShardIteratorType
  - 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:
    
    ShardIteratorType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetShardIteratorRequest.Builder,GetShardIteratorRequest>
    
    Specified by:
    
    toBuilder in class KinesisRequest
  - 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)
```
    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

Class GetShardIteratorRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

streamName

shardId

shardIteratorType

shardIteratorTypeAsString

startingSequenceNumber

timestamp

streamARN

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields