public class PutRecordsRequest extends AmazonWebServiceRequest implements Serializable
PutRecords operation
.
Puts (writes) multiple data records from a producer into an Amazon
Kinesis stream in a single call (also referred to as a
PutRecords
request). Use this operation to send data from
a data producer into the Amazon Kinesis stream for real-time ingestion
and processing. Each shard can support up to 1000 records written per
second, up to a maximum total of 1 MB data written per second.
You must specify the name of the stream that captures, stores, and
transports the data; and an array of request Records
,
with each record in the array requiring a partition key
and data blob.
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 Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. 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. For more information, see Partition Key in the Amazon Kinesis Developer Guide .
Each record in the Records
array may include an optional
parameter, ExplicitHashKey
, which overrides the
partition key to shard mapping. This parameter allows a data producer
to determine explicitly the shard where the record is stored. For more
information, see
Adding Multiple Records with PutRecords
in the Amazon Kinesis Developer Guide .
The PutRecords
response includes an array of response
Records
. Each record in the response array directly
correlates with a record in the request array using natural ordering,
from the top to the bottom of the request and response. The response
Records
array always includes the same number of records
as the request array.
The response Records
array includes both successfully and
unsuccessfully processed records. Amazon Kinesis attempts to process
all records in each PutRecords
request. A single record
failure does not stop the processing of subsequent records.
A successfully-processed record includes ShardId
and
SequenceNumber
values. The ShardId
parameter
identifies the shard in the stream where the record is stored. The
SequenceNumber
parameter is an identifier assigned to the
put record, unique to all records in the stream.
An unsuccessfully-processed record includes ErrorCode
and
ErrorMessage
values. ErrorCode
reflects the
type of error and can be one of the following values:
ProvisionedThroughputExceededException
or
InternalFailure
.
ErrorMessage
provides more detailed
information about the
ProvisionedThroughputExceededException
exception
including the account ID, stream name, and shard ID of the record that
was throttled.
Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.
NOOP
Constructor and Description |
---|
PutRecordsRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
List<PutRecordsRequestEntry> |
getRecords()
The records associated with the request.
|
String |
getStreamName()
The stream name associated with the request.
|
int |
hashCode() |
void |
setRecords(Collection<PutRecordsRequestEntry> records)
The records associated with the request.
|
void |
setStreamName(String streamName)
The stream name associated with the request.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutRecordsRequest |
withRecords(Collection<PutRecordsRequestEntry> records)
The records associated with the request.
|
PutRecordsRequest |
withRecords(PutRecordsRequestEntry... records)
The records associated with the request.
|
PutRecordsRequest |
withStreamName(String streamName)
The stream name associated with the request.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public List<PutRecordsRequestEntry> getRecords()
Constraints:
Length: 1 - 500
public void setRecords(Collection<PutRecordsRequestEntry> records)
Constraints:
Length: 1 - 500
records
- The records associated with the request.public PutRecordsRequest withRecords(PutRecordsRequestEntry... records)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 500
records
- The records associated with the request.public PutRecordsRequest withRecords(Collection<PutRecordsRequestEntry> records)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 500
records
- The records associated with the request.public String getStreamName()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setStreamName(String streamName)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The stream name associated with the request.public PutRecordsRequest withStreamName(String streamName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The stream name associated with the request.public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.