Package software.amazon.awssdk.services.kinesis.model

Class PutRecordRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesis.model.KinesisRequest

software.amazon.awssdk.services.kinesis.model.PutRecordRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutRecordRequest
extends KinesisRequest
implements ToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>

Represents the input for PutRecord.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutRecordRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutRecordRequest.Builder	builder()
SdkBytes	data()	The data blob to put into the record, which is base64-encoded when the blob is serialized.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	explicitHashKey()	The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	partitionKey()	Determines which shard in the stream the data record is assigned to.
List<SdkField<?>>	sdkFields()
String	sequenceNumberForOrdering()	Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.
static Class<? extends PutRecordRequest.Builder>	serializableBuilderClass()
String	streamARN()	The ARN of the stream.
String	streamName()	The name of the stream to put the data record into.
PutRecordRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamName

public final String streamName()

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

Returns:

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

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 (1 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 (1 MiB).

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.

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.

explicitHashKey

public final String explicitHashKey()

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

Returns:

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

sequenceNumberForOrdering

public final 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.

Returns:

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.

streamARN

public final String streamARN()

The ARN of the stream.

Returns:

The ARN of the stream.

toBuilder

public PutRecordRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static PutRecordRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutRecordRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo