Record Class QueueStatus

java.lang.Object

java.lang.Record

org.j7m.middleware.api.messaging.QueueStatus

Record Components:

queue - queue name

depth - live message depth

available - available message count

leased - leased message count

delayed - delayed message count

deadLettered - dead-lettered message count

partitions - immutable partition statuses

metrics - queue metrics snapshot

lastError - redacted last error code or message

All Implemented Interfaces:

Serializable

public record QueueStatus(QueueName queue, long depth, long available, long leased, long delayed, long deadLettered, List<QueuePartitionStatus> partitions, QueueMetricsSnapshot metrics, String lastError)
extends Record
implements Serializable

Queue status and metrics.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
QueueStatus(QueueName queue, long depth, long available, long leased, long delayed, long deadLettered, List<QueuePartitionStatus> partitions, QueueMetricsSnapshot metrics, String lastError)	Creates queue status.

Method Summary

Modifier and Type	Method	Description
long	available()	Returns the value of the available record component.
long	deadLettered()	Returns the value of the deadLettered record component.
long	delayed()	Returns the value of the delayed record component.
long	depth()	Returns the value of the depth record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	lastError()	Returns the value of the lastError record component.
long	leased()	Returns the value of the leased record component.
QueueMetricsSnapshot	metrics()	Returns the value of the metrics record component.
List<QueuePartitionStatus>	partitions()	Returns the value of the partitions record component.
QueueName	queue()	Returns the value of the queue 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

QueueStatus

public QueueStatus(QueueName queue,
 long depth,
 long available,
 long leased,
 long delayed,
 long deadLettered,
 List<QueuePartitionStatus> partitions,
 QueueMetricsSnapshot metrics,
 String lastError)

Creates queue status.

Throws:

IllegalArgumentException - when queue is null

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.

queue

public QueueName queue()

Returns the value of the queue record component.

Returns:

the value of the queue record component

depth

public long depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component

available

public long available()

Returns the value of the available record component.

Returns:

the value of the available record component

leased

public long leased()

Returns the value of the leased record component.

Returns:

the value of the leased record component

delayed

public long delayed()

Returns the value of the delayed record component.

Returns:

the value of the delayed record component

deadLettered

public long deadLettered()

Returns the value of the deadLettered record component.

Returns:

the value of the deadLettered record component

partitions

public List<QueuePartitionStatus> partitions()

Returns the value of the partitions record component.

Returns:

the value of the partitions 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