Class Record

java.lang.Object
software.amazon.awssdk.services.keyspacesstreams.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>

Represents a change data capture record for a row in an Amazon Keyspaces table, containing both the new and old states of the row.

See Also:

  • Method Details

    • eventVersion

      public final String eventVersion()

      The version of the record format, used to track the evolution of the record structure over time.

      Returns:
      The version of the record format, used to track the evolution of the record structure over time.

    • createdAt

      public final Instant createdAt()

      The timestamp indicating when this change data capture record was created.

      Returns:
      The timestamp indicating when this change data capture record was created.

    • origin

      public final OriginType origin()

      The origin or source of this change data capture record.

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

      Returns:
      The origin or source of this change data capture record.
      See Also:

    • originAsString

      public final String originAsString()

      The origin or source of this change data capture record.

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

      Returns:
      The origin or source of this change data capture record.
      See Also:

    • hasPartitionKeys

      public final boolean hasPartitionKeys()
      For responses, this returns true if the service returned a value for the PartitionKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • partitionKeys

      public final Map<String,KeyspacesCellValue> partitionKeys()

      The partition key columns and their values for the affected row.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPartitionKeys() method.

      Returns:
      The partition key columns and their values for the affected row.

    • hasClusteringKeys

      public final boolean hasClusteringKeys()
      For responses, this returns true if the service returned a value for the ClusteringKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • clusteringKeys

      public final Map<String,KeyspacesCellValue> clusteringKeys()

      The clustering key columns and their values for the affected row, which determine the order of rows within a partition.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClusteringKeys() method.

      Returns:
      The clustering key columns and their values for the affected row, which determine the order of rows within a partition.

    • newImage

      public final KeyspacesRow newImage()

      The state of the row after the change operation that generated this record.

      Returns:
      The state of the row after the change operation that generated this record.

    • oldImage

      public final KeyspacesRow oldImage()

      The state of the row before the change operation that generated this record.

      Returns:
      The state of the row before the change operation that generated this record.

    • sequenceNumber

      public final String sequenceNumber()

      A unique identifier assigned to this record within the shard, used for ordering and tracking purposes.

      Returns:
      A unique identifier assigned to this record within the shard, used for ordering and tracking purposes.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.