Interface PutRecordRequest.Builder

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

  • Method Details

    • streamName

      PutRecordRequest.Builder streamName(String streamName)

      The name of the stream to put the data record into.

      Parameters:
      streamName - The name of the stream to put the data record into.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • data

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

    • partitionKey

      PutRecordRequest.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. 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 the record 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. 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 the record 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.

    • explicitHashKey

      PutRecordRequest.Builder explicitHashKey(String explicitHashKey)

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

      Parameters:
      explicitHashKey - The hash value used to explicitly determine the shard 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.

    • sequenceNumberForOrdering

      PutRecordRequest.Builder sequenceNumberForOrdering(String sequenceNumberForOrdering)

      Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

      Parameters:
      sequenceNumberForOrdering - Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamARN

      PutRecordRequest.Builder streamARN(String streamARN)

      The ARN of the stream.

      Parameters:
      streamARN - The ARN of the stream.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamId

      PutRecordRequest.Builder streamId(String streamId)

      Not Implemented. Reserved for future use.

      Parameters:
      streamId - Not Implemented. Reserved for future use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      PutRecordRequest.Builder dryRun(Boolean dryRun)

      Checks if your request will succeed. DryRun is an optional parameter.

      Parameters:
      dryRun - Checks if your request will succeed. DryRun is an optional parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutRecordRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutRecordRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.