PutRecordsRequestEntry (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesis.model.PutRecordsRequestEntry

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutRecordsRequestEntry
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents the output for PutRecords.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PutRecordsRequestEntry()

Constructors
Constructor and Description
`PutRecordsRequestEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutRecordsRequestEntry`	`clone()`
`boolean`	`equals(Object obj)`
`ByteBuffer`	`getData()` The data blob to put into the record, which is base64-encoded when the blob is serialized.
`String`	`getExplicitHashKey()` The hash value used to determine explicitly the shard that 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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setData(ByteBuffer data)` The data blob to put into the record, which is base64-encoded when the blob is serialized.
`void`	`setExplicitHashKey(String explicitHashKey)` The hash value used to determine explicitly the shard that 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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`PutRecordsRequestEntry`	`withData(ByteBuffer data)` The data blob to put into the record, which is base64-encoded when the blob is serialized.
`PutRecordsRequestEntry`	`withExplicitHashKey(String explicitHashKey)` The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
`PutRecordsRequestEntry`	`withPartitionKey(String partitionKey)` Determines which shard in the stream the data record is assigned to.

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

- Constructor Detail
  - PutRecordsRequestEntry
```
public PutRecordsRequestEntry()
```
- Method Detail
  - setData
```
public void setData(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).
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    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).
  - getData
```
public 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).
    
    ByteBuffers 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.
    
    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).
  - withData
```
public PutRecordsRequestEntry withData(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).
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExplicitHashKey
```
public void setExplicitHashKey(String explicitHashKey)
```
    The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
    
    Parameters:
    
    explicitHashKey - The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
  - getExplicitHashKey
```
public String getExplicitHashKey()
```
    The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
    
    Returns:
    
    The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
  - withExplicitHashKey
```
public PutRecordsRequestEntry withExplicitHashKey(String explicitHashKey)
```
    The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
    
    Parameters:
    
    explicitHashKey - The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 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.
    
    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 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.
  - 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 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.
    
    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 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 PutRecordsRequestEntry 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 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.
    
    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 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:
    
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PutRecordsRequestEntry clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PutRecordsRequestEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PutRecordsRequestEntry

Method Detail

setData

getData

withData

setExplicitHashKey

getExplicitHashKey

withExplicitHashKey

setPartitionKey

getPartitionKey

withPartitionKey

toString

equals

hashCode

clone

marshall