software.amazon.awssdk.services.kinesis.model

Class Record

java.lang.Object

software.amazon.awssdk.services.kinesis.model.Record

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Record.Builder,Record>

@Generated(value="software.amazon.awssdk:codegen")
public final class Record
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Record.Builder,Record>

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Record.Builder

Method Summary

Modifier and Type	Method and Description
Instant	approximateArrivalTimestamp() The approximate time that the record was inserted into the stream.
static Record.Builder	builder()
SdkBytes	data() The data blob.
EncryptionType	encryptionType() The encryption type used on the record.
String	encryptionTypeAsString() The encryption type used on the record.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	partitionKey() Identifies which shard in the stream the data record is assigned to.
List<SdkField<?>>	sdkFields()
String	sequenceNumber() The unique identifier of the record within its shard.
static Class<? extends Record.Builder>	serializableBuilderClass()
Record.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sequenceNumber

public final String sequenceNumber()

The unique identifier of the record within its shard.

Returns:

The unique identifier of the record within its shard.

approximateArrivalTimestamp

public final Instant approximateArrivalTimestamp()

The approximate time that the record was inserted into the stream.

Returns:

The approximate time that the record was inserted into the stream.

data

public final SdkBytes data()

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, 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 MiB).

Returns:

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, 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 MiB).

partitionKey

public final String partitionKey()

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.

encryptionType

public final 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 Amazon Web Services KMS key.

If the service returns an enum value that is not available in the current SDK version, encryptionType will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

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 Amazon Web Services KMS key.

See Also:

EncryptionType

encryptionTypeAsString

public final String encryptionTypeAsString()

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 Amazon Web Services KMS key.

If the service returns an enum value that is not available in the current SDK version, encryptionType will return EncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionTypeAsString().

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 Amazon Web Services KMS key.

See Also:

EncryptionType

toBuilder

public Record.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Record.Builder,Record>

builder

public static Record.Builder builder()

serializableBuilderClass

public static Class<? extends Record.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo