Package 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("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:

  • Method Details

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

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

    • toBuilder

      public Record.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Record.Builder,Record>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.