kinesis/aws.sdk.kotlin.services.kinesis.model/GetShardIteratorRequest

GetShardIteratorRequest

class GetShardIteratorRequest

Represents the input for GetShardIterator.

Types

Builder

class Builder

Companion

object Companion

Properties

shardId

val shardId: String?

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

shardIteratorType

val shardIteratorType: ShardIteratorType?

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

startingSequenceNumber

val startingSequenceNumber: String?

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.

streamArn

val streamArn: String?

The ARN of the stream.

streamName

val streamName: String?

The name of the Amazon Kinesis data stream.

timestamp

val timestamp: Instant?

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

Functions

copy

inline fun copy(block: GetShardIteratorRequest.Builder.() -> Unit = {}): GetShardIteratorRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String