Record (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesis.model.Record

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Record
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Record()

Constructors
Constructor and Description
`Record()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`getEncryptionType()` The encryption type used on the record.
`String`	`getPartitionKey()` Identifies which shard in the stream the data record is assigned to.
`String`	`getSequenceNumber()` The unique identifier of the record within its shard.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApproximateArrivalTimestamp(Date approximateArrivalTimestamp)` The approximate time that the record was inserted into the stream.
`void`	`setData(ByteBuffer data)` The data blob.
`void`	`setEncryptionType(String encryptionType)` The encryption type used on the record.
`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 within its shard.
`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`	`withEncryptionType(EncryptionType encryptionType)` The encryption type used on the record.
`Record`	`withEncryptionType(String encryptionType)` The encryption type used on the record.
`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 within its shard.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Record
```
public Record()
```
- Method Detail
  - setSequenceNumber
```
public void setSequenceNumber(String sequenceNumber)
```
    The unique identifier of the record within its shard.
    
    Parameters:
    
    sequenceNumber - The unique identifier of the record within its shard.
  - getSequenceNumber
```
public String getSequenceNumber()
```
    The unique identifier of the record within its shard.
    
    Returns:
    
    The unique identifier of the record within its shard.
  - withSequenceNumber
```
public Record withSequenceNumber(String sequenceNumber)
```
    The unique identifier of the record within its shard.
    
    Parameters:
    
    sequenceNumber - The unique identifier of the record within its shard.
    
    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).
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. 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).
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. 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).
    
    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.
  - setEncryptionType
```
public void setEncryptionType(String encryptionType)
```
    The encryption type used on the record. This parameter can be one of the following values:
    - NONE: Do not encrypt the records in the stream.
    - KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    Parameters:
    encryptionType - The encryption type used on the record. This parameter can be one of the following values:
    
    NONE: Do not encrypt the records in the stream.
    
    KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    See Also:
    
    EncryptionType
  - getEncryptionType
```
public String getEncryptionType()
```
    The encryption type used on the record. This parameter can be one of the following values:
    - NONE: Do not encrypt the records in the stream.
    - KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    Returns:
    The encryption type used on the record. This parameter can be one of the following values:
    
    NONE: Do not encrypt the records in the stream.
    
    KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    See Also:
    
    EncryptionType
  - withEncryptionType
```
public Record withEncryptionType(String encryptionType)
```
    The encryption type used on the record. This parameter can be one of the following values:
    - NONE: Do not encrypt the records in the stream.
    - KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    Parameters:
    encryptionType - The encryption type used on the record. This parameter can be one of the following values:
    
    NONE: Do not encrypt the records in the stream.
    
    KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - withEncryptionType
```
public Record withEncryptionType(EncryptionType encryptionType)
```
    The encryption type used on the record. This parameter can be one of the following values:
    - NONE: Do not encrypt the records in the stream.
    - KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    Parameters:
    encryptionType - The encryption type used on the record. This parameter can be one of the following values:
    
    NONE: Do not encrypt the records in the stream.
    
    KMS: Use server-side encryption on the records in the stream using a customer-managed KMS key.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EncryptionType
  - 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:
    
    Object.toString()
  - 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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Record

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Record

Method Detail

setSequenceNumber

getSequenceNumber

withSequenceNumber

setApproximateArrivalTimestamp

getApproximateArrivalTimestamp

withApproximateArrivalTimestamp

setData

getData

withData

setPartitionKey

getPartitionKey

withPartitionKey

setEncryptionType

getEncryptionType

withEncryptionType

withEncryptionType

toString

equals

hashCode

clone

marshall