org.apache.pulsar.client.api

Enum ProducerAccessMode

java.lang.Object

java.lang.Enum<ProducerAccessMode>

org.apache.pulsar.client.api.ProducerAccessMode

All Implemented Interfaces:

Serializable, Comparable<ProducerAccessMode>

public enum ProducerAccessMode
extends Enum<ProducerAccessMode>

The type of access to the topic that the producer requires.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Exclusive Require exclusive access for producer.
Shared By default multiple producers can publish on a topic.
WaitForExclusive Producer creation is pending until it can acquire exclusive access.

Method Summary

Modifier and Type	Method and Description
static ProducerAccessMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProducerAccessMode[]	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

Shared

public static final ProducerAccessMode Shared

By default multiple producers can publish on a topic.

Exclusive

public static final ProducerAccessMode Exclusive

Require exclusive access for producer. Fail immediately if there's already a producer connected.

WaitForExclusive

public static final ProducerAccessMode WaitForExclusive

Producer creation is pending until it can acquire exclusive access.

Method Detail

values

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

Returns:

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

valueOf

public static ProducerAccessMode 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