Record Class OutboxStatus

java.lang.Object

java.lang.Record

org.j7m.middleware.api.messaging.OutboxStatus

Record Components:

pending - pending outbox entries

published - published outbox entries

failed - failed outbox entries

metrics - queue-wide messaging metrics snapshot

lastError - redacted last error code or message

All Implemented Interfaces:

Serializable

public record OutboxStatus(long pending, long published, long failed, QueueMetricsSnapshot metrics, String lastError)
extends Record
implements Serializable

Outbox status.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OutboxStatus(long pending, long published, long failed, QueueMetricsSnapshot metrics, String lastError)	Creates status.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	failed()	Returns the value of the failed record component.
final int	hashCode()	Returns a hash code value for this object.
String	lastError()	Returns the value of the lastError record component.
QueueMetricsSnapshot	metrics()	Returns the value of the metrics record component.
long	pending()	Returns the value of the pending record component.
long	published()	Returns the value of the published 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

OutboxStatus

public OutboxStatus(long pending,
 long published,
 long failed,
 QueueMetricsSnapshot metrics,
 String lastError)

Creates status.

Throws:

IllegalArgumentException - when counters are negative

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

pending

public long pending()

Returns the value of the pending record component.

Returns:

the value of the pending record component

published

public long published()

Returns the value of the published record component.

Returns:

the value of the published record component

failed

public long failed()

Returns the value of the failed record component.

Returns:

the value of the failed record component

metrics

public QueueMetricsSnapshot metrics()

Returns the value of the metrics record component.

Returns:

the value of the metrics record component

lastError

public String lastError()

Returns the value of the lastError record component.

Returns:

the value of the lastError record component