Record Class BatchResult

java.lang.Object

java.lang.Record

io.awspring.cloud.sns.core.batch.BatchResult

Record Components:

results - Collection of successful message results

errors - Collection of failed message errors

public record BatchResult(Collection<BatchResult.SnsResult> results, Collection<BatchResult.SnsError> errors)
extends Record

Result of a batch publish operation to SNS.

Contains both successful results and errors from the batch operation. Use hasErrors() or isFullySuccessful() to check the overall status of the batch operation.

Since:

4.1.0

Author:

Matej Nedic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	BatchResult.SnsError	Represents a failed message in a batch operation.
static final record	BatchResult.SnsResult	Represents a successfully published message in a batch operation.

Constructor Summary

Constructors

Constructor	Description
BatchResult(Collection<BatchResult.SnsResult> results, Collection<BatchResult.SnsError> errors)	Creates an instance of a BatchResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Collection<BatchResult.SnsError>	errors()	Returns the value of the errors record component.
boolean	hasErrors()	Checks if any messages in the batch failed to publish.
final int	hashCode()	Returns a hash code value for this object.
boolean	isFullySuccessful()	Checks if all messages in the batch were successfully published.
Collection<BatchResult.SnsResult>	results()	Returns the value of the results record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BatchResult

public BatchResult(Collection<BatchResult.SnsResult> results,
 Collection<BatchResult.SnsError> errors)

Creates an instance of a BatchResult record class.

Parameters:

results - the value for the results record component

errors - the value for the errors record component

Method Details

hasErrors

public boolean hasErrors()

Checks if any messages in the batch failed to publish.

Returns:

true if there are any errors, false otherwise

isFullySuccessful

public boolean isFullySuccessful()

Checks if all messages in the batch were successfully published.

Returns:

true if there are no errors, false otherwise

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

results

public Collection<BatchResult.SnsResult> results()

Returns the value of the results record component.

Returns:

the value of the results record component

errors

public Collection<BatchResult.SnsError> errors()

Returns the value of the errors record component.

Returns:

the value of the errors record component