Class Record
- java.lang.Object
-
- com.amazonaws.services.kinesis.model.Record
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class Record extends Object implements Serializable, Cloneable
The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Record()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Record
clone()
boolean
equals(Object obj)
Date
getApproximateArrivalTimestamp()
The approximate time that the record was inserted into the stream.ByteBuffer
getData()
The data blob.String
getPartitionKey()
Identifies which shard in the stream the data record is assigned to.String
getSequenceNumber()
The unique identifier of the record in the stream.int
hashCode()
void
setApproximateArrivalTimestamp(Date approximateArrivalTimestamp)
The approximate time that the record was inserted into the stream.void
setData(ByteBuffer data)
The data blob.void
setPartitionKey(String partitionKey)
Identifies which shard in the stream the data record is assigned to.void
setSequenceNumber(String sequenceNumber)
The unique identifier of the record in the stream.String
toString()
Returns a string representation of this object; useful for testing and debugging.Record
withApproximateArrivalTimestamp(Date approximateArrivalTimestamp)
The approximate time that the record was inserted into the stream.Record
withData(ByteBuffer data)
The data blob.Record
withPartitionKey(String partitionKey)
Identifies which shard in the stream the data record is assigned to.Record
withSequenceNumber(String sequenceNumber)
The unique identifier of the record in the stream.
-
-
-
Method Detail
-
setSequenceNumber
public void setSequenceNumber(String sequenceNumber)
The unique identifier of the record in the stream.
- Parameters:
sequenceNumber
- The unique identifier of the record in the stream.
-
getSequenceNumber
public String getSequenceNumber()
The unique identifier of the record in the stream.
- Returns:
- The unique identifier of the record in the stream.
-
withSequenceNumber
public Record withSequenceNumber(String sequenceNumber)
The unique identifier of the record in the stream.
- Parameters:
sequenceNumber
- The unique identifier of the record in the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setApproximateArrivalTimestamp
public void setApproximateArrivalTimestamp(Date approximateArrivalTimestamp)
The approximate time that the record was inserted into the stream.
- Parameters:
approximateArrivalTimestamp
- The approximate time that the record was inserted into the stream.
-
getApproximateArrivalTimestamp
public Date getApproximateArrivalTimestamp()
The approximate time that the record was inserted into the stream.
- Returns:
- The approximate time that the record was inserted into the stream.
-
withApproximateArrivalTimestamp
public Record withApproximateArrivalTimestamp(Date approximateArrivalTimestamp)
The approximate time that the record was inserted into the stream.
- Parameters:
approximateArrivalTimestamp
- The approximate time that the record was inserted into the stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setData
public void setData(ByteBuffer data)
The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
AWS SDK for Java performs a Base64 encoding on this field before sending this request to AWS service by default. Users of the SDK should not perform Base64 encoding on this field.
Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
- Parameters:
data
- The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
-
getData
public ByteBuffer getData()
The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
ByteBuffer
s are stateful. Calling theirget
methods changes theirposition
. We recommend usingByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independentposition
, and callingget
methods on this rather than directly on the returnedByteBuffer
. Doing so will ensure that anyone else using theByteBuffer
will not be affected by changes to theposition
.- Returns:
- The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
-
withData
public Record withData(ByteBuffer data)
The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).
- Parameters:
data
- The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPartitionKey
public void setPartitionKey(String partitionKey)
Identifies which shard in the stream the data record is assigned to.
- Parameters:
partitionKey
- Identifies which shard in the stream the data record is assigned to.
-
getPartitionKey
public String getPartitionKey()
Identifies which shard in the stream the data record is assigned to.
- Returns:
- Identifies which shard in the stream the data record is assigned to.
-
withPartitionKey
public Record withPartitionKey(String partitionKey)
Identifies which shard in the stream the data record is assigned to.
- Parameters:
partitionKey
- Identifies which shard in the stream the data record is assigned to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-