Package com.couchbase.client.core.io.netty.kv

Enum MemcacheProtocol.Opcode

java.lang.Object

java.lang.Enum<MemcacheProtocol.Opcode>

com.couchbase.client.core.io.netty.kv.MemcacheProtocol.Opcode

All Implemented Interfaces:

Serializable, Comparable<MemcacheProtocol.Opcode>

Enclosing class:

MemcacheProtocol

public static enum MemcacheProtocol.Opcode
extends Enum<MemcacheProtocol.Opcode>

Contains all known/used kv protocol opcodes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADD	The add (insert) command.
APPEND	Binary append.
COLLECTIONS_GET_CID	Returns the ID of a collection/scope combination
COLLECTIONS_GET_MANIFEST	Returns the collections manifest for a bucket.
DECREMENT	Decrement binary counter.
DELETE	The delete (remove) command.
DELETE_WITH_META	Deletes (tombstones) a document while setting metadata.
ERROR_MAP	Command used to fetch the error map during the bootstrap process.
GET	The get command.
GET_AND_LOCK	Allows to get a document and perform a write lock at the same time.
GET_AND_TOUCH	Allows to get a document and reset its expiry at the same time.
GET_CONFIG	Returns the current configuration for the bucket ("cccp").
GET_META	Fetches metadata for a document
GET_REPLICA	A replica get operation.
HELLO	The hello command used during bootstrap to negoatiate the features.
INCREMENT	Increment binary counter.
NOOP	The noop command.
OBSERVE_CAS	Performs an observe call with the CAS option.
OBSERVE_SEQ	Performs an observe call via sequence numbers.
PREPEND	Binary prepend.
RANGE_SCAN_CANCEL	Cancel a range scan.
RANGE_SCAN_CONTINUE	Get more results from a range scan.
RANGE_SCAN_CREATE	Create a new range scan.
REPLACE	The replace command.
SASL_AUTH	Initial auth step in the SASL negotiation.
SASL_LIST_MECHS	List all SASL auth mechanisms the server supports.
SASL_STEP	Subsequent steps in the SASL negotiation.
SELECT_BUCKET	Command used to select a specific bucket on a connection.
SET	The set (upsert) command.
SUBDOC_MULTI_LOOKUP	Subdocument lookup with more than one element.
SUBDOC_MULTI_MUTATE	Subdocument multi mutation.
TOUCH	Touch command sets a new expiration.
UNLOCK	Unlocks a write locked document.

Method Summary

Modifier and Type	Method	Description
static MemcacheProtocol.Opcode	of(byte input)
byte	opcode()	Returns the opcode for the given command.
static MemcacheProtocol.Opcode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MemcacheProtocol.Opcode[]	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

GET

public static final MemcacheProtocol.Opcode GET

The get command.

SET

public static final MemcacheProtocol.Opcode SET

The set (upsert) command.

ADD

public static final MemcacheProtocol.Opcode ADD

The add (insert) command.

REPLACE

public static final MemcacheProtocol.Opcode REPLACE

The replace command.

DELETE

public static final MemcacheProtocol.Opcode DELETE

The delete (remove) command.

INCREMENT

public static final MemcacheProtocol.Opcode INCREMENT

Increment binary counter.

DECREMENT

public static final MemcacheProtocol.Opcode DECREMENT

Decrement binary counter.

NOOP

public static final MemcacheProtocol.Opcode NOOP

The noop command.

APPEND

public static final MemcacheProtocol.Opcode APPEND

Binary append.

PREPEND

public static final MemcacheProtocol.Opcode PREPEND

Binary prepend.

HELLO

public static final MemcacheProtocol.Opcode HELLO

The hello command used during bootstrap to negoatiate the features.

ERROR_MAP

public static final MemcacheProtocol.Opcode ERROR_MAP

Command used to fetch the error map during the bootstrap process.

SELECT_BUCKET

public static final MemcacheProtocol.Opcode SELECT_BUCKET

Command used to select a specific bucket on a connection.

SASL_LIST_MECHS

public static final MemcacheProtocol.Opcode SASL_LIST_MECHS

List all SASL auth mechanisms the server supports.

SASL_AUTH

public static final MemcacheProtocol.Opcode SASL_AUTH

Initial auth step in the SASL negotiation.

SASL_STEP

public static final MemcacheProtocol.Opcode SASL_STEP

Subsequent steps in the SASL negotiation.

GET_CONFIG

public static final MemcacheProtocol.Opcode GET_CONFIG

Returns the current configuration for the bucket ("cccp").

COLLECTIONS_GET_CID

public static final MemcacheProtocol.Opcode COLLECTIONS_GET_CID

Returns the ID of a collection/scope combination

SUBDOC_MULTI_LOOKUP

public static final MemcacheProtocol.Opcode SUBDOC_MULTI_LOOKUP

Subdocument lookup with more than one element.

SUBDOC_MULTI_MUTATE

public static final MemcacheProtocol.Opcode SUBDOC_MULTI_MUTATE

Subdocument multi mutation.

GET_AND_TOUCH

public static final MemcacheProtocol.Opcode GET_AND_TOUCH

Allows to get a document and reset its expiry at the same time.

GET_AND_LOCK

public static final MemcacheProtocol.Opcode GET_AND_LOCK

Allows to get a document and perform a write lock at the same time.

OBSERVE_CAS

public static final MemcacheProtocol.Opcode OBSERVE_CAS

Performs an observe call with the CAS option.

OBSERVE_SEQ

public static final MemcacheProtocol.Opcode OBSERVE_SEQ

Performs an observe call via sequence numbers.

GET_REPLICA

public static final MemcacheProtocol.Opcode GET_REPLICA

A replica get operation.

TOUCH

public static final MemcacheProtocol.Opcode TOUCH

Touch command sets a new expiration.

UNLOCK

public static final MemcacheProtocol.Opcode UNLOCK

Unlocks a write locked document.

DELETE_WITH_META

public static final MemcacheProtocol.Opcode DELETE_WITH_META

Deletes (tombstones) a document while setting metadata.

COLLECTIONS_GET_MANIFEST

public static final MemcacheProtocol.Opcode COLLECTIONS_GET_MANIFEST

Returns the collections manifest for a bucket.

GET_META

public static final MemcacheProtocol.Opcode GET_META

Fetches metadata for a document

RANGE_SCAN_CREATE

@SinceCouchbase("7.2")
public static final MemcacheProtocol.Opcode RANGE_SCAN_CREATE

Create a new range scan.

RANGE_SCAN_CONTINUE

@SinceCouchbase("7.2")
public static final MemcacheProtocol.Opcode RANGE_SCAN_CONTINUE

Get more results from a range scan.

RANGE_SCAN_CANCEL

@SinceCouchbase("7.2")
public static final MemcacheProtocol.Opcode RANGE_SCAN_CANCEL

Cancel a range scan. (Not required if scan completes normally.)

Method Detail

values

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

Returns:

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

valueOf

public static MemcacheProtocol.Opcode 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

opcode

public byte opcode()

Returns the opcode for the given command.

Returns:

the opcode for the command.

of

@Nullable
public static MemcacheProtocol.Opcode of(byte input)