com.amazonaws.services.kinesis.model.PutRecordsRequestEntry Maven / Gradle / Ivy
Show all versions of aws-android-sdk-kinesis Show documentation
/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.kinesis.model;
import java.io.Serializable;
/**
*
* Represents the output for PutRecords .
*
*/
public class PutRecordsRequestEntry implements Serializable {
/**
* 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
*/
private java.nio.ByteBuffer data;
/**
* The hash value used to determine explicitly the shard that the data
* record is assigned to by overriding the partition key hash.
*
* Constraints:
* Pattern: 0|([1-9]\d{0,38})
*/
private String explicitHashKey;
/**
* 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.
*
* Constraints:
* Length: 1 - 256
*/
private String partitionKey;
/**
* 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
*
* @return 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).
*/
public java.nio.ByteBuffer getData() {
return 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
*
* @param 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).
*/
public void setData(java.nio.ByteBuffer data) {
this.data = 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
*
* @param 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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutRecordsRequestEntry withData(java.nio.ByteBuffer data) {
this.data = data;
return this;
}
/**
* The hash value used to determine explicitly the shard that the data
* record is assigned to by overriding the partition key hash.
*
* Constraints:
* Pattern: 0|([1-9]\d{0,38})
*
* @return The hash value used to determine explicitly the shard that the data
* record is assigned to by overriding the partition key hash.
*/
public String getExplicitHashKey() {
return explicitHashKey;
}
/**
* The hash value used to determine explicitly the shard that the data
* record is assigned to by overriding the partition key hash.
*
* Constraints:
* Pattern: 0|([1-9]\d{0,38})
*
* @param explicitHashKey The hash value used to determine explicitly the shard that the data
* record is assigned to by overriding the partition key hash.
*/
public void setExplicitHashKey(String explicitHashKey) {
this.explicitHashKey = explicitHashKey;
}
/**
* The hash value used to determine explicitly the shard that 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})
*
* @param explicitHashKey The hash value used to determine explicitly the shard that the data
* record is assigned to by overriding the partition key hash.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutRecordsRequestEntry withExplicitHashKey(String explicitHashKey) {
this.explicitHashKey = explicitHashKey;
return this;
}
/**
* 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.
*
* Constraints:
* Length: 1 - 256
*
* @return 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 getPartitionKey() {
return 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.
*
* Constraints:
* Length: 1 - 256
*
* @param 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 void setPartitionKey(String partitionKey) {
this.partitionKey = 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 a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 256
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutRecordsRequestEntry withPartitionKey(String partitionKey) {
this.partitionKey = partitionKey;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getData() != null) sb.append("Data: " + getData() + ",");
if (getExplicitHashKey() != null) sb.append("ExplicitHashKey: " + getExplicitHashKey() + ",");
if (getPartitionKey() != null) sb.append("PartitionKey: " + getPartitionKey() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getData() == null) ? 0 : getData().hashCode());
hashCode = prime * hashCode + ((getExplicitHashKey() == null) ? 0 : getExplicitHashKey().hashCode());
hashCode = prime * hashCode + ((getPartitionKey() == null) ? 0 : getPartitionKey().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PutRecordsRequestEntry == false) return false;
PutRecordsRequestEntry other = (PutRecordsRequestEntry)obj;
if (other.getData() == null ^ this.getData() == null) return false;
if (other.getData() != null && other.getData().equals(this.getData()) == false) return false;
if (other.getExplicitHashKey() == null ^ this.getExplicitHashKey() == null) return false;
if (other.getExplicitHashKey() != null && other.getExplicitHashKey().equals(this.getExplicitHashKey()) == false) return false;
if (other.getPartitionKey() == null ^ this.getPartitionKey() == null) return false;
if (other.getPartitionKey() != null && other.getPartitionKey().equals(this.getPartitionKey()) == false) return false;
return true;
}
}