com.amazonaws.services.kinesis.model.PutRecordResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2019-2024 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;
import javax.annotation.Generated;
/**
*
* Represents the output for PutRecord.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutRecordResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The shard ID of the shard where the data record was placed.
*
*/
private String shardId;
/**
*
* The sequence number identifier that was assigned to the put data record. The sequence number for the record is
* unique across all records in the stream. A sequence number is the identifier associated with every record put
* into the stream.
*
*/
private String sequenceNumber;
/**
*
* The encryption type to use on the record. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*/
private String encryptionType;
/**
*
* The shard ID of the shard where the data record was placed.
*
*
* @param shardId
* The shard ID of the shard where the data record was placed.
*/
public void setShardId(String shardId) {
this.shardId = shardId;
}
/**
*
* The shard ID of the shard where the data record was placed.
*
*
* @return The shard ID of the shard where the data record was placed.
*/
public String getShardId() {
return this.shardId;
}
/**
*
* The shard ID of the shard where the data record was placed.
*
*
* @param shardId
* The shard ID of the shard where the data record was placed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordResult withShardId(String shardId) {
setShardId(shardId);
return this;
}
/**
*
* The sequence number identifier that was assigned to the put data record. The sequence number for the record is
* unique across all records in the stream. A sequence number is the identifier associated with every record put
* into the stream.
*
*
* @param sequenceNumber
* The sequence number identifier that was assigned to the put data record. The sequence number for the
* record is unique across all records in the stream. A sequence number is the identifier associated with
* every record put into the stream.
*/
public void setSequenceNumber(String sequenceNumber) {
this.sequenceNumber = sequenceNumber;
}
/**
*
* The sequence number identifier that was assigned to the put data record. The sequence number for the record is
* unique across all records in the stream. A sequence number is the identifier associated with every record put
* into the stream.
*
*
* @return The sequence number identifier that was assigned to the put data record. The sequence number for the
* record is unique across all records in the stream. A sequence number is the identifier associated with
* every record put into the stream.
*/
public String getSequenceNumber() {
return this.sequenceNumber;
}
/**
*
* The sequence number identifier that was assigned to the put data record. The sequence number for the record is
* unique across all records in the stream. A sequence number is the identifier associated with every record put
* into the stream.
*
*
* @param sequenceNumber
* The sequence number identifier that was assigned to the put data record. The sequence number for the
* record is unique across all records in the stream. A sequence number is the identifier associated with
* every record put into the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordResult withSequenceNumber(String sequenceNumber) {
setSequenceNumber(sequenceNumber);
return this;
}
/**
*
* The encryption type to use on the record. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type to use on the record. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon
* Web Services KMS key.
*
*
* @see EncryptionType
*/
public void setEncryptionType(String encryptionType) {
this.encryptionType = encryptionType;
}
/**
*
* The encryption type to use on the record. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* @return The encryption type to use on the record. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon
* Web Services KMS key.
*
*
* @see EncryptionType
*/
public String getEncryptionType() {
return this.encryptionType;
}
/**
*
* The encryption type to use on the record. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type to use on the record. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon
* Web Services KMS key.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public PutRecordResult withEncryptionType(String encryptionType) {
setEncryptionType(encryptionType);
return this;
}
/**
*
* The encryption type to use on the record. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type to use on the record. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon
* Web Services KMS key.
*
*
* @see EncryptionType
*/
public void setEncryptionType(EncryptionType encryptionType) {
withEncryptionType(encryptionType);
}
/**
*
* The encryption type to use on the record. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web
* Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type to use on the record. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records in the stream.
*
*
* -
*
* KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon
* Web Services KMS key.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public PutRecordResult withEncryptionType(EncryptionType encryptionType) {
this.encryptionType = encryptionType.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getShardId() != null)
sb.append("ShardId: ").append(getShardId()).append(",");
if (getSequenceNumber() != null)
sb.append("SequenceNumber: ").append(getSequenceNumber()).append(",");
if (getEncryptionType() != null)
sb.append("EncryptionType: ").append(getEncryptionType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutRecordResult == false)
return false;
PutRecordResult other = (PutRecordResult) obj;
if (other.getShardId() == null ^ this.getShardId() == null)
return false;
if (other.getShardId() != null && other.getShardId().equals(this.getShardId()) == false)
return false;
if (other.getSequenceNumber() == null ^ this.getSequenceNumber() == null)
return false;
if (other.getSequenceNumber() != null && other.getSequenceNumber().equals(this.getSequenceNumber()) == false)
return false;
if (other.getEncryptionType() == null ^ this.getEncryptionType() == null)
return false;
if (other.getEncryptionType() != null && other.getEncryptionType().equals(this.getEncryptionType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getShardId() == null) ? 0 : getShardId().hashCode());
hashCode = prime * hashCode + ((getSequenceNumber() == null) ? 0 : getSequenceNumber().hashCode());
hashCode = prime * hashCode + ((getEncryptionType() == null) ? 0 : getEncryptionType().hashCode());
return hashCode;
}
@Override
public PutRecordResult clone() {
try {
return (PutRecordResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}