Interface PutRecordsRequestEntry.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PutRecordsRequestEntry.Builder,PutRecordsRequestEntry>, SdkBuilder<PutRecordsRequestEntry.Builder,PutRecordsRequestEntry>, SdkPojo
Enclosing class:
PutRecordsRequestEntry
@Mutable @NotThreadSafe public static interface PutRecordsRequestEntry.Builder extends SdkPojo, CopyableBuilder<PutRecordsRequestEntry.Builder,PutRecordsRequestEntry>

  • Method Details

    • data

      PutRecordsRequestEntry.Builder data(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • explicitHashKey

      PutRecordsRequestEntry.Builder explicitHashKey(String explicitHashKey)

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

      Parameters:
      explicitHashKey - The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partitionKey

      PutRecordsRequestEntry.Builder partitionKey(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.