com.amazonaws.services.kinesis.model.PutRecordsResultEntry 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Represents the result of an individual record from a PutRecords request. A record that is successfully
* added to a stream includes SequenceNumber and ShardId in the result. A record that fails to
* be added to the stream includes ErrorCode and ErrorMessage in the result.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutRecordsResultEntry implements Serializable, Cloneable, StructuredPojo {
/**
*
* The sequence number for an individual record result.
*
*/
private String sequenceNumber;
/**
*
* The shard ID for an individual record result.
*
*/
private String shardId;
/**
*
* The error code for an individual record result. ErrorCodes can be either
* ProvisionedThroughputExceededException or InternalFailure.
*
*/
private String errorCode;
/**
*
* The error message for an individual record result. An ErrorCode value of
* ProvisionedThroughputExceededException has an error message that includes the account ID, stream
* name, and shard ID. An ErrorCode value of InternalFailure has the error message
* "Internal Service Failure".
*
*/
private String errorMessage;
/**
*
* The sequence number for an individual record result.
*
*
* @param sequenceNumber
* The sequence number for an individual record result.
*/
public void setSequenceNumber(String sequenceNumber) {
this.sequenceNumber = sequenceNumber;
}
/**
*
* The sequence number for an individual record result.
*
*
* @return The sequence number for an individual record result.
*/
public String getSequenceNumber() {
return this.sequenceNumber;
}
/**
*
* The sequence number for an individual record result.
*
*
* @param sequenceNumber
* The sequence number for an individual record result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordsResultEntry withSequenceNumber(String sequenceNumber) {
setSequenceNumber(sequenceNumber);
return this;
}
/**
*
* The shard ID for an individual record result.
*
*
* @param shardId
* The shard ID for an individual record result.
*/
public void setShardId(String shardId) {
this.shardId = shardId;
}
/**
*
* The shard ID for an individual record result.
*
*
* @return The shard ID for an individual record result.
*/
public String getShardId() {
return this.shardId;
}
/**
*
* The shard ID for an individual record result.
*
*
* @param shardId
* The shard ID for an individual record result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordsResultEntry withShardId(String shardId) {
setShardId(shardId);
return this;
}
/**
*
* The error code for an individual record result. ErrorCodes can be either
* ProvisionedThroughputExceededException or InternalFailure.
*
*
* @param errorCode
* The error code for an individual record result. ErrorCodes can be either
* ProvisionedThroughputExceededException or InternalFailure.
*/
public void setErrorCode(String errorCode) {
this.errorCode = errorCode;
}
/**
*
* The error code for an individual record result. ErrorCodes can be either
* ProvisionedThroughputExceededException or InternalFailure.
*
*
* @return The error code for an individual record result. ErrorCodes can be either
* ProvisionedThroughputExceededException or InternalFailure.
*/
public String getErrorCode() {
return this.errorCode;
}
/**
*
* The error code for an individual record result. ErrorCodes can be either
* ProvisionedThroughputExceededException or InternalFailure.
*
*
* @param errorCode
* The error code for an individual record result. ErrorCodes can be either
* ProvisionedThroughputExceededException or InternalFailure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordsResultEntry withErrorCode(String errorCode) {
setErrorCode(errorCode);
return this;
}
/**
*
* The error message for an individual record result. An ErrorCode value of
* ProvisionedThroughputExceededException has an error message that includes the account ID, stream
* name, and shard ID. An ErrorCode value of InternalFailure has the error message
* "Internal Service Failure".
*
*
* @param errorMessage
* The error message for an individual record result. An ErrorCode value of
* ProvisionedThroughputExceededException has an error message that includes the account ID,
* stream name, and shard ID. An ErrorCode value of InternalFailure has the error
* message "Internal Service Failure".
*/
public void setErrorMessage(String errorMessage) {
this.errorMessage = errorMessage;
}
/**
*
* The error message for an individual record result. An ErrorCode value of
* ProvisionedThroughputExceededException has an error message that includes the account ID, stream
* name, and shard ID. An ErrorCode value of InternalFailure has the error message
* "Internal Service Failure".
*
*
* @return The error message for an individual record result. An ErrorCode value of
* ProvisionedThroughputExceededException has an error message that includes the account ID,
* stream name, and shard ID. An ErrorCode value of InternalFailure has the error
* message "Internal Service Failure".
*/
public String getErrorMessage() {
return this.errorMessage;
}
/**
*
* The error message for an individual record result. An ErrorCode value of
* ProvisionedThroughputExceededException has an error message that includes the account ID, stream
* name, and shard ID. An ErrorCode value of InternalFailure has the error message
* "Internal Service Failure".
*
*
* @param errorMessage
* The error message for an individual record result. An ErrorCode value of
* ProvisionedThroughputExceededException has an error message that includes the account ID,
* stream name, and shard ID. An ErrorCode value of InternalFailure has the error
* message "Internal Service Failure".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutRecordsResultEntry withErrorMessage(String errorMessage) {
setErrorMessage(errorMessage);
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 (getSequenceNumber() != null)
sb.append("SequenceNumber: ").append(getSequenceNumber()).append(",");
if (getShardId() != null)
sb.append("ShardId: ").append(getShardId()).append(",");
if (getErrorCode() != null)
sb.append("ErrorCode: ").append(getErrorCode()).append(",");
if (getErrorMessage() != null)
sb.append("ErrorMessage: ").append(getErrorMessage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutRecordsResultEntry == false)
return false;
PutRecordsResultEntry other = (PutRecordsResultEntry) obj;
if (other.getSequenceNumber() == null ^ this.getSequenceNumber() == null)
return false;
if (other.getSequenceNumber() != null && other.getSequenceNumber().equals(this.getSequenceNumber()) == false)
return false;
if (other.getShardId() == null ^ this.getShardId() == null)
return false;
if (other.getShardId() != null && other.getShardId().equals(this.getShardId()) == false)
return false;
if (other.getErrorCode() == null ^ this.getErrorCode() == null)
return false;
if (other.getErrorCode() != null && other.getErrorCode().equals(this.getErrorCode()) == false)
return false;
if (other.getErrorMessage() == null ^ this.getErrorMessage() == null)
return false;
if (other.getErrorMessage() != null && other.getErrorMessage().equals(this.getErrorMessage()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSequenceNumber() == null) ? 0 : getSequenceNumber().hashCode());
hashCode = prime * hashCode + ((getShardId() == null) ? 0 : getShardId().hashCode());
hashCode = prime * hashCode + ((getErrorCode() == null) ? 0 : getErrorCode().hashCode());
hashCode = prime * hashCode + ((getErrorMessage() == null) ? 0 : getErrorMessage().hashCode());
return hashCode;
}
@Override
public PutRecordsResultEntry clone() {
try {
return (PutRecordsResultEntry) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kinesis.model.transform.PutRecordsResultEntryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}