PutRecordRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesis.model.PutRecordRequest

All Implemented Interfaces:

Serializable
```
public class PutRecordRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the PutRecord operation.
This operation puts a data record into an Amazon Kinesis stream from a producer. This operation must be called to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing. The PutRecord operation requires the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. The data blob could be a segment from a log file, geographic/location data, website clickstream data, or any other data type.

The partition key is used to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

Partition keys are Unicode strings, with a maximum length limit of 256 bytes. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see the Amazon Kinesis Developer Guide .

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

The SequenceNumberForOrdering sets the initial sequence number for the partition key. Later PutRecord requests to the same partition key (from the same client) will automatically increase from SequenceNumberForOrdering , ensuring strict sequential ordering.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException .

Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.

See Also:
AmazonKinesis.putRecord(PutRecordRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

PutRecordRequest()

Constructors
Constructor and Description
`PutRecordRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`ByteBuffer`	`getData()` The data blob to put into the record, which must be Base64 encoded.
`String`	`getExplicitHashKey()` The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
`String`	`getPartitionKey()` Determines which shard in the stream the data record is assigned to.
`String`	`getSequenceNumberForOrdering()` The sequence number to use as the initial number for the partition key.
`String`	`getStreamName()` The name of the stream to put the data record into.
`int`	`hashCode()`
`void`	`setData(ByteBuffer data)` The data blob to put into the record, which must be Base64 encoded.
`void`	`setExplicitHashKey(String explicitHashKey)` The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
`void`	`setPartitionKey(String partitionKey)` Determines which shard in the stream the data record is assigned to.
`void`	`setSequenceNumberForOrdering(String sequenceNumberForOrdering)` The sequence number to use as the initial number for the partition key.
`void`	`setStreamName(String streamName)` The name of the stream to put the data record into.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutRecordRequest`	`withData(ByteBuffer data)` The data blob to put into the record, which must be Base64 encoded.
`PutRecordRequest`	`withExplicitHashKey(String explicitHashKey)` The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
`PutRecordRequest`	`withPartitionKey(String partitionKey)` Determines which shard in the stream the data record is assigned to.
`PutRecordRequest`	`withSequenceNumberForOrdering(String sequenceNumberForOrdering)` The sequence number to use as the initial number for the partition key.
`PutRecordRequest`	`withStreamName(String streamName)` The name of the stream to put the data record into.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutRecordRequest
```
public PutRecordRequest()
```
- Method Detail
  - getStreamName
```
public String getStreamName()
```
    The name of the stream to put the data record into.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    The name of the stream to put the data record into.
  - setStreamName
```
public void setStreamName(String streamName)
```
    The name of the stream to put the data record into.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream to put the data record into.
  - withStreamName
```
public PutRecordRequest withStreamName(String streamName)
```
    The name of the stream to put the data record into.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    streamName - The name of the stream to put the data record into.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getData
```
public ByteBuffer getData()
```
    The data blob to put into the record, which must be Base64 encoded. The maximum size of the data blob is 50 kilobytes (KB).
    Constraints:
    Length: 0 - 51200
    
    Returns:
    The data blob to put into the record, which must be Base64 encoded. The maximum size of the data blob is 50 kilobytes (KB).
  - setData
```
public void setData(ByteBuffer data)
```
    The data blob to put into the record, which must be Base64 encoded. The maximum size of the data blob is 50 kilobytes (KB).
    Constraints:
    Length: 0 - 51200
    
    Parameters:
    data - The data blob to put into the record, which must be Base64 encoded. The maximum size of the data blob is 50 kilobytes (KB).
  - withData
```
public PutRecordRequest withData(ByteBuffer data)
```
    The data blob to put into the record, which must be Base64 encoded. The maximum size of the data blob is 50 kilobytes (KB).
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 51200
    
    Parameters:
    data - The data blob to put into the record, which must be Base64 encoded. The maximum size of the data blob is 50 kilobytes (KB).
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPartitionKey
```
public String getPartitionKey()
```
    Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 bytes. 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 will map to the same shard within the stream.
    Constraints:
    Length: 1 - 256
    
    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 bytes. 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 will map to the same shard within the stream.
  - setPartitionKey
```
public void setPartitionKey(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 bytes. 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 will map to the same shard within the stream.
    Constraints:
    Length: 1 - 256
    
    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 bytes. 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 will map to the same shard within the stream.
  - withPartitionKey
```
public PutRecordRequest withPartitionKey(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 bytes. 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 will map to the same shard within the stream.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    
    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 bytes. 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 will map to the same shard within the stream.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getExplicitHashKey
```
public String getExplicitHashKey()
```
    The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
    Constraints:
    Pattern: 0|([1-9]\d{0,38})
    
    Returns:
    The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
  - setExplicitHashKey
```
public void setExplicitHashKey(String explicitHashKey)
```
    The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
    Constraints:
    Pattern: 0|([1-9]\d{0,38})
    
    Parameters:
    explicitHashKey - The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
  - withExplicitHashKey
```
public PutRecordRequest withExplicitHashKey(String explicitHashKey)
```
    The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: 0|([1-9]\d{0,38})
    
    Parameters:
    explicitHashKey - The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSequenceNumberForOrdering
```
public String getSequenceNumberForOrdering()
```
    The sequence number to use as the initial number for the partition key. Subsequent calls to PutRecord from the same client and for the same partition key will increase from the SequenceNumberForOrdering value.
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    Returns:
    The sequence number to use as the initial number for the partition key. Subsequent calls to PutRecord from the same client and for the same partition key will increase from the SequenceNumberForOrdering value.
  - setSequenceNumberForOrdering
```
public void setSequenceNumberForOrdering(String sequenceNumberForOrdering)
```
    The sequence number to use as the initial number for the partition key. Subsequent calls to PutRecord from the same client and for the same partition key will increase from the SequenceNumberForOrdering value.
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    Parameters:
    sequenceNumberForOrdering - The sequence number to use as the initial number for the partition key. Subsequent calls to PutRecord from the same client and for the same partition key will increase from the SequenceNumberForOrdering value.
  - withSequenceNumberForOrdering
```
public PutRecordRequest withSequenceNumberForOrdering(String sequenceNumberForOrdering)
```
    The sequence number to use as the initial number for the partition key. Subsequent calls to PutRecord from the same client and for the same partition key will increase from the SequenceNumberForOrdering value.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    Parameters:
    sequenceNumberForOrdering - The sequence number to use as the initial number for the partition key. Subsequent calls to PutRecord from the same client and for the same partition key will increase from the SequenceNumberForOrdering value.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class PutRecordRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutRecordRequest

Method Detail

getStreamName

setStreamName

withStreamName

getData

setData

withData

getPartitionKey

setPartitionKey

withPartitionKey

getExplicitHashKey

setExplicitHashKey

withExplicitHashKey

getSequenceNumberForOrdering

setSequenceNumberForOrdering

withSequenceNumberForOrdering

toString

hashCode

equals