com.couchbase.client.dcp.message

Enum StreamFlags

java.lang.Object

java.lang.Enum<StreamFlags>

com.couchbase.client.dcp.message.StreamFlags

All Implemented Interfaces:

Serializable, Comparable<StreamFlags>

public enum StreamFlags
extends Enum<StreamFlags>

Flags, that could be used when initiating new vBucket stream.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE_VB_ONLY Indicate the server to add stream only if the VBucket is active.
DISK_ONLY Specifies that the stream should only send items only if they are on disk.
LATEST Specifies that the server should stream all mutations up to the current sequence number for that VBucket.
NO_VALUE Deprecated. (Removed in 5.0, use OpenConnectionFlag.NO_VALUE when opening the connection instead)
STRICT_VB_UUID Indicate the server to check for vb_uuid match even at start_seqno 0 before adding the stream successfully.
TAKEOVER Specifies that the stream should send over all remaining data to the remote node and then set the remote nodes VBucket to active state and the source nodes VBucket to dead.

Method Summary

Modifier and Type	Method and Description
static Set<StreamFlags>	decode(int flags)
static int	encode(Set<StreamFlags> flags)
boolean	isSet(int flags)
int	value()
static StreamFlags	valueOf(String name) Returns the enum constant of this type with the specified name.
static StreamFlags[]	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

TAKEOVER

public static final StreamFlags TAKEOVER

Specifies that the stream should send over all remaining data to the remote node and then set the remote nodes VBucket to active state and the source nodes VBucket to dead.

DISK_ONLY

public static final StreamFlags DISK_ONLY

Specifies that the stream should only send items only if they are on disk. The first item sent is specified by the start sequence number and items will be sent up to the sequence number specified by the end sequence number or the last on disk item when the stream is created.

LATEST

public static final StreamFlags LATEST

Specifies that the server should stream all mutations up to the current sequence number for that VBucket. The server will overwrite the value of the end sequence number field with the value of the latest sequence number.

NO_VALUE

@Deprecated
public static final StreamFlags NO_VALUE

Deprecated. (Removed in 5.0, use OpenConnectionFlag.NO_VALUE when opening the connection instead)

Specifies that the server should stream only item key and metadata in the mutations and not stream the value of the item.

ACTIVE_VB_ONLY

public static final StreamFlags ACTIVE_VB_ONLY

Indicate the server to add stream only if the VBucket is active. If the VBucket is not active, the stream request fails with ERR_NOT_MY_VBUCKET (0x07)

STRICT_VB_UUID

public static final StreamFlags STRICT_VB_UUID

Indicate the server to check for vb_uuid match even at start_seqno 0 before adding the stream successfully. If the flag is set and there is a vb_uuid mismatch at start_seqno 0, then the server returns ENGINE_ROLLBACK error.

Method Detail

values

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

Returns:

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

valueOf

public static StreamFlags 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<StreamFlags> flags)

decode

public static Set<StreamFlags> decode(int flags)