Record Class LeaseOptions

java.lang.Object

java.lang.Record

org.j7m.middleware.api.messaging.LeaseOptions

Record Components:

maxMessages - maximum messages to lease

visibilityTimeout - visibility timeout for leased messages

consumerGroupId - optional consumer group identity

All Implemented Interfaces:

Serializable

public record LeaseOptions(int maxMessages, VisibilityTimeout visibilityTimeout, ConsumerGroupId consumerGroupId)
extends Record
implements Serializable

Lease request options.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LeaseOptions(int maxMessages, VisibilityTimeout visibilityTimeout, ConsumerGroupId consumerGroupId)	Creates lease options.

Method Summary

Modifier and Type	Method	Description
ConsumerGroupId	consumerGroupId()	Returns the value of the consumerGroupId record component.
static LeaseOptions	defaults()	Returns default lease options.
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.
int	maxMessages()	Returns the value of the maxMessages record component.
final String	toString()	Returns a string representation of this record class.
VisibilityTimeout	visibilityTimeout()	Returns the value of the visibilityTimeout record component.

Methods inherited from class Object

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

Constructor Details

LeaseOptions

public LeaseOptions(int maxMessages,
 VisibilityTimeout visibilityTimeout,
 ConsumerGroupId consumerGroupId)

Creates lease options.

Method Details

defaults

public static LeaseOptions defaults()

Returns default lease options.

Returns:

default lease options

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.

maxMessages

public int maxMessages()

Returns the value of the maxMessages record component.

Returns:

the value of the maxMessages record component

visibilityTimeout

public VisibilityTimeout visibilityTimeout()

Returns the value of the visibilityTimeout record component.

Returns:

the value of the visibilityTimeout record component

consumerGroupId

public ConsumerGroupId consumerGroupId()

Returns the value of the consumerGroupId record component.

Returns:

the value of the consumerGroupId record component