com.amazonaws.services.kinesis.model.PutRecordsResult 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;
/**
*
* PutRecords results.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutRecordsResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The number of unsuccessfully processed records in a PutRecords request.
*
*/
private Integer failedRecordCount;
/**
*
* An array of successfully and unsuccessfully processed record results. A record that is successfully added to a
* stream includes SequenceNumber and ShardId in the result. A record that fails to be
* added to a stream includes ErrorCode and ErrorMessage in the result.
*
*/
private com.amazonaws.internal.SdkInternalList records;
/**
*
* The encryption type used on the records. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
*
*
*
*/
private String encryptionType;
/**
*
* The number of unsuccessfully processed records in a PutRecords request.
*
*
* @param failedRecordCount
* The number of unsuccessfully processed records in a PutRecords request.
*/
public void setFailedRecordCount(Integer failedRecordCount) {
this.failedRecordCount = failedRecordCount;
}
/**
*
* The number of unsuccessfully processed records in a PutRecords request.
*
*
* @return The number of unsuccessfully processed records in a PutRecords request.
*/
public Integer getFailedRecordCount() {
return this.failedRecordCount;
}
/**
*
* The number of unsuccessfully processed records in a PutRecords request.
*
*
* @param failedRecordCount
* The number of unsuccessfully processed records in a PutRecords request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordsResult withFailedRecordCount(Integer failedRecordCount) {
setFailedRecordCount(failedRecordCount);
return this;
}
/**
*
* An array of successfully and unsuccessfully processed record results. A record that is successfully added to a
* stream includes SequenceNumber and ShardId in the result. A record that fails to be
* added to a stream includes ErrorCode and ErrorMessage in the result.
*
*
* @return An array of successfully and unsuccessfully processed record results. A record that is successfully added
* to a stream includes SequenceNumber and ShardId in the result. A record that
* fails to be added to a stream includes ErrorCode and ErrorMessage in the
* result.
*/
public java.util.List getRecords() {
if (records == null) {
records = new com.amazonaws.internal.SdkInternalList();
}
return records;
}
/**
*
* An array of successfully and unsuccessfully processed record results. A record that is successfully added to a
* stream includes SequenceNumber and ShardId in the result. A record that fails to be
* added to a stream includes ErrorCode and ErrorMessage in the result.
*
*
* @param records
* An array of successfully and unsuccessfully processed record results. A record that is successfully added
* to a stream includes SequenceNumber and ShardId in the result. A record that
* fails to be added to a stream includes ErrorCode and ErrorMessage in the result.
*/
public void setRecords(java.util.Collection records) {
if (records == null) {
this.records = null;
return;
}
this.records = new com.amazonaws.internal.SdkInternalList(records);
}
/**
*
* An array of successfully and unsuccessfully processed record results. A record that is successfully added to a
* stream includes SequenceNumber and ShardId in the result. A record that fails to be
* added to a stream includes ErrorCode and ErrorMessage in the result.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRecords(java.util.Collection)} or {@link #withRecords(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param records
* An array of successfully and unsuccessfully processed record results. A record that is successfully added
* to a stream includes SequenceNumber and ShardId in the result. A record that
* fails to be added to a stream includes ErrorCode and ErrorMessage in the result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordsResult withRecords(PutRecordsResultEntry... records) {
if (this.records == null) {
setRecords(new com.amazonaws.internal.SdkInternalList(records.length));
}
for (PutRecordsResultEntry ele : records) {
this.records.add(ele);
}
return this;
}
/**
*
* An array of successfully and unsuccessfully processed record results. A record that is successfully added to a
* stream includes SequenceNumber and ShardId in the result. A record that fails to be
* added to a stream includes ErrorCode and ErrorMessage in the result.
*
*
* @param records
* An array of successfully and unsuccessfully processed record results. A record that is successfully added
* to a stream includes SequenceNumber and ShardId in the result. A record that
* fails to be added to a stream includes ErrorCode and ErrorMessage in the result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordsResult withRecords(java.util.Collection records) {
setRecords(records);
return this;
}
/**
*
* The encryption type used on the records. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type used on the records. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services
* KMS key.
*
*
* @see EncryptionType
*/
public void setEncryptionType(String encryptionType) {
this.encryptionType = encryptionType;
}
/**
*
* The encryption type used on the records. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
*
*
*
*
* @return The encryption type used on the records. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services
* KMS key.
*
*
* @see EncryptionType
*/
public String getEncryptionType() {
return this.encryptionType;
}
/**
*
* The encryption type used on the records. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type used on the records. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records 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 PutRecordsResult withEncryptionType(String encryptionType) {
setEncryptionType(encryptionType);
return this;
}
/**
*
* The encryption type used on the records. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type used on the records. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services
* KMS key.
*
*
* @see EncryptionType
*/
public void setEncryptionType(EncryptionType encryptionType) {
withEncryptionType(encryptionType);
}
/**
*
* The encryption type used on the records. This parameter can be one of the following values:
*
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
*
*
*
*
* @param encryptionType
* The encryption type used on the records. This parameter can be one of the following values:
*
* -
*
* NONE: Do not encrypt the records.
*
*
* -
*
* KMS: Use server-side encryption on the records 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 PutRecordsResult 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 (getFailedRecordCount() != null)
sb.append("FailedRecordCount: ").append(getFailedRecordCount()).append(",");
if (getRecords() != null)
sb.append("Records: ").append(getRecords()).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 PutRecordsResult == false)
return false;
PutRecordsResult other = (PutRecordsResult) obj;
if (other.getFailedRecordCount() == null ^ this.getFailedRecordCount() == null)
return false;
if (other.getFailedRecordCount() != null && other.getFailedRecordCount().equals(this.getFailedRecordCount()) == false)
return false;
if (other.getRecords() == null ^ this.getRecords() == null)
return false;
if (other.getRecords() != null && other.getRecords().equals(this.getRecords()) == 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 + ((getFailedRecordCount() == null) ? 0 : getFailedRecordCount().hashCode());
hashCode = prime * hashCode + ((getRecords() == null) ? 0 : getRecords().hashCode());
hashCode = prime * hashCode + ((getEncryptionType() == null) ? 0 : getEncryptionType().hashCode());
return hashCode;
}
@Override
public PutRecordsResult clone() {
try {
return (PutRecordsResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}