@Generated(value="software.amazon.awssdk:codegen") public class PutRecordRequest extends AmazonWebServiceRequest implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>
Represents the input for PutRecord
.
Modifier and Type | Class and Description |
---|---|
static interface |
PutRecordRequest.Builder |
NOOP
Modifier and Type | Method and Description |
---|---|
static PutRecordRequest.Builder |
builder() |
ByteBuffer |
data()
The data blob to put into the record, which is base64-encoded when the blob is serialized.
|
boolean |
equals(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.
|
int |
hashCode() |
String |
partitionKey()
Determines which shard in the stream the data record is assigned to.
|
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 |
streamName()
The name of the stream to put the data record into.
|
PutRecordRequest.Builder |
toBuilder() |
String |
toString() |
clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout
public String streamName()
The name of the stream to put the data record into.
public ByteBuffer 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 MB).
ByteBuffer
s are stateful. Calling their get
methods changes their position
. We recommend
using ByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independent
position
, and calling get
methods on this rather than directly on the returned ByteBuffer
. Doing so will ensure that anyone else using the ByteBuffer
will not be affected by changes to the
position
.
public 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 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.
public String explicitHashKey()
The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
public 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 will
be coarsely ordered based on arrival time.
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 will be coarsely ordered based on arrival time.public PutRecordRequest.Builder toBuilder()
toBuilder
in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<PutRecordRequest.Builder,PutRecordRequest>
public static PutRecordRequest.Builder builder()
public static Class<? extends PutRecordRequest.Builder> serializableBuilderClass()
Copyright © 2017. All rights reserved.