org.apache.pulsar.client.api

Enum SubscriptionInitialPosition

java.lang.Object

java.lang.Enum<SubscriptionInitialPosition>

org.apache.pulsar.client.api.SubscriptionInitialPosition

All Implemented Interfaces:

Serializable, Comparable<SubscriptionInitialPosition>

public enum SubscriptionInitialPosition
extends Enum<SubscriptionInitialPosition>

When creating a consumer, if the subscription does not exist, a new subscription will be created. By default the subscription will be created at the end of the topic. See #subscriptionInitialPosition(SubscriptionInitialPosition) to configure the initial position behavior.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Earliest The earliest position which means the start consuming position will be the first message.
Latest The latest position which means the start consuming position will be the last message.

Method Summary

Modifier and Type	Method and Description
int	getValue()
static SubscriptionInitialPosition	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubscriptionInitialPosition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Latest

public static final SubscriptionInitialPosition Latest

The latest position which means the start consuming position will be the last message.

Earliest

public static final SubscriptionInitialPosition Earliest

The earliest position which means the start consuming position will be the first message.

Method Detail

values

public static SubscriptionInitialPosition[] 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 (SubscriptionInitialPosition c : SubscriptionInitialPosition.values())
    System.out.println(c);

Returns:

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

valueOf

public static SubscriptionInitialPosition valueOf(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:

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

NullPointerException - if the argument is null

getValue

public final int getValue()