PutRecordRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class PutRecordRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

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

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. 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 Adding Data to a Stream in the Amazon Kinesis Data Streams 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.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

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

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PutRecordRequest()

Constructors
Constructor and Description
`PutRecordRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.nio.ByteBuffer`	`getData()` The data blob to put into the record, which is base64-encoded when the blob is serialized.
`java.lang.String`	`getExplicitHashKey()` The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
`java.lang.String`	`getPartitionKey()` Determines which shard in the stream the data record is assigned to.
`java.lang.String`	`getSequenceNumberForOrdering()` Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.
`java.lang.String`	`getStreamName()` The name of the stream to put the data record into.
`int`	`hashCode()`
`void`	`setData(java.nio.ByteBuffer data)` The data blob to put into the record, which is base64-encoded when the blob is serialized.
`void`	`setExplicitHashKey(java.lang.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(java.lang.String partitionKey)` Determines which shard in the stream the data record is assigned to.
`void`	`setSequenceNumberForOrdering(java.lang.String sequenceNumberForOrdering)` Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.
`void`	`setStreamName(java.lang.String streamName)` The name of the stream to put the data record into.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutRecordRequest`	`withData(java.nio.ByteBuffer data)` The data blob to put into the record, which is base64-encoded when the blob is serialized.
`PutRecordRequest`	`withExplicitHashKey(java.lang.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(java.lang.String partitionKey)` Determines which shard in the stream the data record is assigned to.
`PutRecordRequest`	`withSequenceNumberForOrdering(java.lang.String sequenceNumberForOrdering)` Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.
`PutRecordRequest`	`withStreamName(java.lang.String streamName)` The name of the stream to put the data record into.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - PutRecordRequest
```
public PutRecordRequest()
```
- Method Detail
  - getStreamName
```
public java.lang.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(java.lang.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(java.lang.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 java.nio.ByteBuffer getData()
```
    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).
    
    Constraints:
    Length: 0 - 1048576
    
    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 MB).
  - setData
```
public void setData(java.nio.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).
    
    Constraints:
    Length: 0 - 1048576
    
    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 (1 MB).
  - withData
```
public PutRecordRequest withData(java.nio.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).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 1048576
    
    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 (1 MB).
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPartitionKey
```
public java.lang.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 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.
    
    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 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.
  - setPartitionKey
```
public void setPartitionKey(java.lang.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.
    
    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 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.
  - withPartitionKey
```
public PutRecordRequest withPartitionKey(java.lang.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 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 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:
    
    A reference to this updated object so that method calls can be chained together.
  - getExplicitHashKey
```
public java.lang.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(java.lang.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(java.lang.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 java.lang.String getSequenceNumberForOrdering()
```
    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.
    
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    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.
  - setSequenceNumberForOrdering
```
public void setSequenceNumberForOrdering(java.lang.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.
    
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    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.
  - withSequenceNumberForOrdering
```
public PutRecordRequest withSequenceNumberForOrdering(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: 0|([1-9]\d{0,128})
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

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