Package com.couchbase.client.dcp.message

Enum OpenConnectionFlag

java.lang.Object
java.lang.Enum<OpenConnectionFlag>
com.couchbase.client.dcp.message.OpenConnectionFlag
All Implemented Interfaces:
Serializable, Comparable<OpenConnectionFlag>
public enum OpenConnectionFlag extends Enum<OpenConnectionFlag>

  • Enum Constant Details

    • PRODUCER

      public static final OpenConnectionFlag PRODUCER
      Tells the remote peer to act as a DCP producer.

      If this bit is clear, the remote peer acts as a DCP consumer (unless the NOTIFIER flag is set, which it shouldn't be since it's deprecated).

    • NOTIFIER

      @Deprecated public static final OpenConnectionFlag NOTIFIER
      Deprecated.
      Notifier connections are deprecated with no replacement.

    • INCLUDE_XATTRS

      public static final OpenConnectionFlag INCLUDE_XATTRS
      Requests that DCP_MUTATION, DCP_DELETION and DCP_EXPIRATION (if enabled) messages should include any XATTRs associated with the Document.

    • NO_VALUE

      public static final OpenConnectionFlag NO_VALUE
      Requests that DCP_MUTATION, DCP_DELETION and DCP_EXPIRATION (if enabled) messages do not include the Document.

    • INCLUDE_DELETE_TIMES

      public static final OpenConnectionFlag INCLUDE_DELETE_TIMES
      Requests that DCP_DELETION messages include metadata regarding when a document was deleted. When a delete is persisted to disk, it is timestamped and purged from the vbucket after some interval. When 'include delete times' is enabled, deletes which are read from disk will have a timestamp value in the delete-time field, in-memory deletes will have a 0 value in the delete-time field. See DCP deletion command. Note when enabled on a consumer, the consumer expects the client to send the delete-time format DCP delete.

  • Method Details

    • values

      public static OpenConnectionFlag[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

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

    • value

      public int value()

    • isSet

      public boolean isSet(int flags)

    • encode

      public static int encode(Set<OpenConnectionFlag> flags)