Package org.apache.pulsar.client.api

Enum Class SubscriptionInitialPosition

java.lang.Object

java.lang.Enum<SubscriptionInitialPosition>

org.apache.pulsar.client.api.SubscriptionInitialPosition

All Implemented Interfaces:

Serializable, Comparable<SubscriptionInitialPosition>, Constable

@Public
@Stable
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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
final int	getValue()
static SubscriptionInitialPosition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SubscriptionInitialPosition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static SubscriptionInitialPosition[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SubscriptionInitialPosition valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public final int getValue()