Class PutRecordsResultEntry
- All Implemented Interfaces:
Serializable
,Cloneable
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 Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The error code for an individual record result.The error message for an individual record result.The sequence number for an individual record result.The shard ID for an individual record result.int
hashCode()
void
setErrorCode
(String errorCode) The error code for an individual record result.void
setErrorMessage
(String errorMessage) The error message for an individual record result.void
setSequenceNumber
(String sequenceNumber) The sequence number for an individual record result.void
setShardId
(String shardId) The shard ID for an individual record result.toString()
Returns a string representation of this object; useful for testing and debugging.withErrorCode
(String errorCode) The error code for an individual record result.withErrorMessage
(String errorMessage) The error message for an individual record result.withSequenceNumber
(String sequenceNumber) The sequence number for an individual record result.withShardId
(String shardId) The shard ID for an individual record result.
-
Constructor Details
-
PutRecordsResultEntry
public PutRecordsResultEntry()
-
-
Method Details
-
setSequenceNumber
The sequence number for an individual record result.
- Parameters:
sequenceNumber
- The sequence number for an individual record result.
-
getSequenceNumber
The sequence number for an individual record result.
- Returns:
- The sequence number for an individual record result.
-
withSequenceNumber
The sequence number for an individual record result.
- Parameters:
sequenceNumber
- The sequence number for an individual record result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setShardId
The shard ID for an individual record result.
- Parameters:
shardId
- The shard ID for an individual record result.
-
getShardId
The shard ID for an individual record result.
- Returns:
- The shard ID for an individual record result.
-
withShardId
The shard ID for an individual record result.
- Parameters:
shardId
- The shard ID for an individual record result.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setErrorCode
The error code for an individual record result.
ErrorCodes
can be eitherProvisionedThroughputExceededException
orInternalFailure
.- Parameters:
errorCode
- The error code for an individual record result.ErrorCodes
can be eitherProvisionedThroughputExceededException
orInternalFailure
.
-
getErrorCode
The error code for an individual record result.
ErrorCodes
can be eitherProvisionedThroughputExceededException
orInternalFailure
.- Returns:
- The error code for an individual record result.
ErrorCodes
can be eitherProvisionedThroughputExceededException
orInternalFailure
.
-
withErrorCode
The error code for an individual record result.
ErrorCodes
can be eitherProvisionedThroughputExceededException
orInternalFailure
.- Parameters:
errorCode
- The error code for an individual record result.ErrorCodes
can be eitherProvisionedThroughputExceededException
orInternalFailure
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setErrorMessage
The error message for an individual record result. An
ErrorCode
value ofProvisionedThroughputExceededException
has an error message that includes the account ID, stream name, and shard ID. AnErrorCode
value ofInternalFailure
has the error message"Internal Service Failure"
.- Parameters:
errorMessage
- The error message for an individual record result. AnErrorCode
value ofProvisionedThroughputExceededException
has an error message that includes the account ID, stream name, and shard ID. AnErrorCode
value ofInternalFailure
has the error message"Internal Service Failure"
.
-
getErrorMessage
The error message for an individual record result. An
ErrorCode
value ofProvisionedThroughputExceededException
has an error message that includes the account ID, stream name, and shard ID. AnErrorCode
value ofInternalFailure
has the error message"Internal Service Failure"
.- Returns:
- The error message for an individual record result. An
ErrorCode
value ofProvisionedThroughputExceededException
has an error message that includes the account ID, stream name, and shard ID. AnErrorCode
value ofInternalFailure
has the error message"Internal Service Failure"
.
-
withErrorMessage
The error message for an individual record result. An
ErrorCode
value ofProvisionedThroughputExceededException
has an error message that includes the account ID, stream name, and shard ID. AnErrorCode
value ofInternalFailure
has the error message"Internal Service Failure"
.- Parameters:
errorMessage
- The error message for an individual record result. AnErrorCode
value ofProvisionedThroughputExceededException
has an error message that includes the account ID, stream name, and shard ID. AnErrorCode
value ofInternalFailure
has the error message"Internal Service Failure"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-