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:
  • Constructor Details

    • Record

      public Record()
  • Method Details

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

      ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position .

      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 class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public Record clone()
      Overrides:
      clone in class Object