/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.kinesis.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* Represents the input for GetShardIterator. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetShardIteratorRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The name of the Amazon Kinesis data stream. *

*/ private String streamName; /** *

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

*/ private String shardId; /** *

* 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: *

* */ private String shardIteratorType; /** *

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

*/ private String startingSequenceNumber; /** *

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

*/ private java.util.Date timestamp; /** *

* The ARN of the stream. *

*/ private String streamARN; /** *

* The name of the Amazon Kinesis data stream. *

* * @param streamName * The name of the Amazon Kinesis data stream. */ public void setStreamName(String streamName) { this.streamName = streamName; } /** *

* The name of the Amazon Kinesis data stream. *

* * @return The name of the Amazon Kinesis data stream. */ public String getStreamName() { return this.streamName; } /** *

* The name of the Amazon Kinesis data stream. *

* * @param streamName * The name of the Amazon Kinesis data stream. * @return Returns a reference to this object so that method calls can be chained together. */ public GetShardIteratorRequest withStreamName(String streamName) { setStreamName(streamName); return this; } /** *

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

* * @param shardId * The shard ID of the Kinesis Data Streams shard to get the iterator for. */ public void setShardId(String shardId) { this.shardId = shardId; } /** *

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

* * @return The shard ID of the Kinesis Data Streams shard to get the iterator for. */ public String getShardId() { return this.shardId; } /** *

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

* * @param shardId * The shard ID of the Kinesis Data Streams shard to get the iterator for. * @return Returns a reference to this object so that method calls can be chained together. */ public GetShardIteratorRequest withShardId(String shardId) { setShardId(shardId); return this; } /** *

* 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: *

* * * @param 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: *

*