Class PutRecordsRequestEntry

java.lang.Object
software.amazon.awssdk.services.kinesis.model.PutRecordsRequestEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PutRecordsRequestEntry.Builder,PutRecordsRequestEntry>
@Generated("software.amazon.awssdk:codegen") public final class PutRecordsRequestEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PutRecordsRequestEntry.Builder,PutRecordsRequestEntry>

Represents the output for PutRecords.

See Also:

  • Method Details

    • data

      public final SdkBytes data()

      The data blob to put into the record, which is base64-encoded when the blob is serialized. 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 (10 MiB).

      Returns:
      The data blob to put into the record, which is base64-encoded when the blob is serialized. 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 (10 MiB).

    • explicitHashKey

      public final String explicitHashKey()

      The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

      Returns:
      The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

    • partitionKey

      public final String partitionKey()

      Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

      If the stream uses the USER_PARTITION_KEY record distribution strategy (the default), a partition key is required for each record. If the stream uses the AUTO record distribution strategy, the partition key is optional and any value you provide is ignored, along with any ExplicitHashKey you provide. In that case, Amazon Kinesis Data Streams distributes records across shards using service-managed algorithms. For more information, see UpdateStreamRecordDistributionStrategy.

      Returns:
      Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

      If the stream uses the USER_PARTITION_KEY record distribution strategy (the default), a partition key is required for each record. If the stream uses the AUTO record distribution strategy, the partition key is optional and any value you provide is ignored, along with any ExplicitHashKey you provide. In that case, Amazon Kinesis Data Streams distributes records across shards using service-managed algorithms. For more information, see UpdateStreamRecordDistributionStrategy.

    • toBuilder

      public PutRecordsRequestEntry.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<PutRecordsRequestEntry.Builder,PutRecordsRequestEntry>
      Returns:
      a builder for type T

    • builder

      public static PutRecordsRequestEntry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutRecordsRequestEntry.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.