io.nats.client.api

Enum PriorityPolicy

java.lang.Object

java.lang.Enum<PriorityPolicy>

io.nats.client.api.PriorityPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PriorityPolicy>

public enum PriorityPolicy
extends java.lang.Enum<PriorityPolicy>

Represents the Priority Policy of a consumer

See Also:

nats-io ADR-42 Setting a priority policy will also require setting a Priority group.
When a priority policy and priority group are set, client instances making pull request need to specify the priority group and optionally other ConsumerOptions See {@link io.nats.client.BaseConsumeOptions}

Enum Constant Summary

Enum Constants

Enum Constant and Description
None Standard consumer.
Overflow Each client pull request specifies overflow limits in the BaseConsumeOptions Currently minPending and minAckPending are respected.
PinnedClient If multiple clients make requests only ONE will be served messages.
Prioritized The client pull request will specify a priortity from 1 to 10 in the BaseConsumeOptions Request with lower priority will be served first.

Method Summary

Modifier and Type	Method and Description
static @Nullable PriorityPolicy	get(java.lang.String value) Get an instance from the JSON value
java.lang.String	toString()
static PriorityPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PriorityPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final PriorityPolicy None

Standard consumer. All client instances are load balance fairly.

Overflow

public static final PriorityPolicy Overflow

Each client pull request specifies overflow limits in the BaseConsumeOptions
Currently minPending and minAckPending are respected.
When either the minimum number of pending messages (not yet delivered to any client) OR the number pending acks is exceeded the pull request will return messages.

Prioritized

public static final PriorityPolicy Prioritized

The client pull request will specify a priortity from 1 to 10 in the BaseConsumeOptions
Request with lower priority will be served first. That is, higher priority request will only be served when no pull request from lower priorities are pending.

PinnedClient

public static final PriorityPolicy PinnedClient

If multiple clients make requests only ONE will be served messages. The API will identify clients through a UUID.
. If a client fails to make requests for more than the timeout specified in BaseConsumeOptions another client will be served.

Method Detail

values

public static PriorityPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PriorityPolicy c : PriorityPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PriorityPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<PriorityPolicy>

get

public static @Nullable PriorityPolicy get(java.lang.String value)

Get an instance from the JSON value

Parameters:

value - the value

Returns:

the instance or null if the string is not matched