com.amazonaws.services.kinesis.model.GetShardIteratorRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2019-2024 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:
*
*
* -
*
* 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.
*
*
*
*/
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:
*
*
* -
*
* 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.
*
*
*
*
* @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:
*
*
* -
*
* 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 ShardIteratorType
*/
public void setShardIteratorType(String shardIteratorType) {
this.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.
*
*
*
*
* @return 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 ShardIteratorType
*/
public String getShardIteratorType() {
return this.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.
*
*
*
*
* @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:
*
*
* -
*
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ShardIteratorType
*/
public GetShardIteratorRequest withShardIteratorType(String shardIteratorType) {
setShardIteratorType(shardIteratorType);
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:
*
*
* -
*
* 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.
*
*
*
*
* @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:
*
*
* -
*
* 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 ShardIteratorType
*/
public void setShardIteratorType(ShardIteratorType shardIteratorType) {
withShardIteratorType(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.
*
*
*
*
* @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:
*
*
* -
*
* 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ShardIteratorType
*/
public GetShardIteratorRequest withShardIteratorType(ShardIteratorType shardIteratorType) {
this.shardIteratorType = shardIteratorType.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setStartingSequenceNumber(String startingSequenceNumber) {
this.startingSequenceNumber = 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.
*
*
* @return 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.
*/
public String getStartingSequenceNumber() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetShardIteratorRequest withStartingSequenceNumber(String startingSequenceNumber) {
setStartingSequenceNumber(startingSequenceNumber);
return this;
}
/**
*
* 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).
*
*
* @param 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).
*/
public void setTimestamp(java.util.Date timestamp) {
this.timestamp = 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).
*
*
* @return 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).
*/
public java.util.Date getTimestamp() {
return this.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).
*
*
* @param 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).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetShardIteratorRequest withTimestamp(java.util.Date timestamp) {
setTimestamp(timestamp);
return this;
}
/**
*
* The ARN of the stream.
*
*
* @param streamARN
* The ARN of the stream.
*/
public void setStreamARN(String streamARN) {
this.streamARN = streamARN;
}
/**
*
* The ARN of the stream.
*
*
* @return The ARN of the stream.
*/
public String getStreamARN() {
return this.streamARN;
}
/**
*
* The ARN of the stream.
*
*
* @param streamARN
* The ARN of the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetShardIteratorRequest withStreamARN(String streamARN) {
setStreamARN(streamARN);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStreamName() != null)
sb.append("StreamName: ").append(getStreamName()).append(",");
if (getShardId() != null)
sb.append("ShardId: ").append(getShardId()).append(",");
if (getShardIteratorType() != null)
sb.append("ShardIteratorType: ").append(getShardIteratorType()).append(",");
if (getStartingSequenceNumber() != null)
sb.append("StartingSequenceNumber: ").append(getStartingSequenceNumber()).append(",");
if (getTimestamp() != null)
sb.append("Timestamp: ").append(getTimestamp()).append(",");
if (getStreamARN() != null)
sb.append("StreamARN: ").append(getStreamARN());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetShardIteratorRequest == false)
return false;
GetShardIteratorRequest other = (GetShardIteratorRequest) obj;
if (other.getStreamName() == null ^ this.getStreamName() == null)
return false;
if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false)
return false;
if (other.getShardId() == null ^ this.getShardId() == null)
return false;
if (other.getShardId() != null && other.getShardId().equals(this.getShardId()) == false)
return false;
if (other.getShardIteratorType() == null ^ this.getShardIteratorType() == null)
return false;
if (other.getShardIteratorType() != null && other.getShardIteratorType().equals(this.getShardIteratorType()) == false)
return false;
if (other.getStartingSequenceNumber() == null ^ this.getStartingSequenceNumber() == null)
return false;
if (other.getStartingSequenceNumber() != null && other.getStartingSequenceNumber().equals(this.getStartingSequenceNumber()) == false)
return false;
if (other.getTimestamp() == null ^ this.getTimestamp() == null)
return false;
if (other.getTimestamp() != null && other.getTimestamp().equals(this.getTimestamp()) == false)
return false;
if (other.getStreamARN() == null ^ this.getStreamARN() == null)
return false;
if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode());
hashCode = prime * hashCode + ((getShardId() == null) ? 0 : getShardId().hashCode());
hashCode = prime * hashCode + ((getShardIteratorType() == null) ? 0 : getShardIteratorType().hashCode());
hashCode = prime * hashCode + ((getStartingSequenceNumber() == null) ? 0 : getStartingSequenceNumber().hashCode());
hashCode = prime * hashCode + ((getTimestamp() == null) ? 0 : getTimestamp().hashCode());
hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode());
return hashCode;
}
@Override
public GetShardIteratorRequest clone() {
return (GetShardIteratorRequest) super.clone();
}
}