Package org.apache.pulsar.client.api

Enum ProducerAccessMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ProducerAccessMode>
    public enum ProducerAccessMode
extends java.lang.Enum<ProducerAccessMode>
    The type of access to the topic that the producer requires.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ProducerAccessMode valueOf​(java.lang.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​(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