Enum ServerFeature
- All Implemented Interfaces:
Serializable
,Comparable<ServerFeature>
,java.lang.constant.Constable
@Internal public enum ServerFeature extends Enum<ServerFeature>
The
ServerFeature
enum describes all the different negotiation modes
between the server and the SDK.- Since:
- 2.0.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants Enum Constant Description ALT_REQUEST
Allows the server to accept requests with flexible extras.CLUSTERMAP_CHANGE_NOTIFICATION
Request the server to push any cluster maps stored by ns_server into one of the buckets the client have access to.COLLECTIONS
Enables the collections feature.CREATE_AS_DELETED
Enables the "create as deleted" flag, allowing a document to be created in a tombstoned state.DATATYPE
Deprecated.this feature is considered retired.DUPLEX
Enables Duplex mode support.JSON
Enables JSON data identification support.MUTATION_SEQNO
Returns the sequence number on every mutation.PRESERVE_TTL
Enables preserving expiry when updating document.SELECT_BUCKET
Enable select_bucket support.SNAPPY
Enable snappy-based compression support.SYNC_REPLICATION
Specify durability requirements for mutations.TCPDELAY
Disable TCP Nodelay.TCPNODELAY
Enables TCP Nodelay.TLS
The TLS feature.TRACING
Enable tracing support.UNORDERED_EXECUTION
Tell the server that we're ok with the server reordering the execution of commands.VATTR
Enables the vattr feature.XATTR
Enable xattr support.XERROR
Enable extended error map support. -
Method Summary
Modifier and Type Method Description short
value()
Returns the actual byte value for the wire protocol.static ServerFeature
valueOf(String name)
Returns the enum constant of this type with the specified name.static ServerFeature[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
DATATYPE
Deprecated.this feature is considered retired.The custom datatype feature.- Since:
- Couchbase Server 4.0
-
TLS
The TLS feature. -
TCPNODELAY
Enables TCP Nodelay.- Since:
- Couchbase Server 4.0
-
MUTATION_SEQNO
Returns the sequence number on every mutation.- Since:
- Couchbase Server 4.0
-
TCPDELAY
Disable TCP Nodelay.- Since:
- Couchbase Server 4.0
-
XATTR
Enable xattr support.- Since:
- Couchbase Server Spock (5.0)
-
XERROR
Enable extended error map support.- Since:
- Couchbase Server Spock (5.0)
-
SELECT_BUCKET
Enable select_bucket support.- Since:
- Couchbase Server Spock (5.0)
-
SNAPPY
Enable snappy-based compression support.- Since:
- Couchbase Server Vulcan (5.5)
-
JSON
Enables JSON data identification support.- Since:
- Couchbase Server Vulcan (5.5)
-
DUPLEX
Enables Duplex mode support. -
CLUSTERMAP_CHANGE_NOTIFICATION
Request the server to push any cluster maps stored by ns_server into one of the buckets the client have access to. -
UNORDERED_EXECUTION
Tell the server that we're ok with the server reordering the execution of commands. -
TRACING
Enable tracing support.- Since:
- Couchbase Server Vulcan (5.5)
-
ALT_REQUEST
Allows the server to accept requests with flexible extras. -
SYNC_REPLICATION
Specify durability requirements for mutations. -
COLLECTIONS
Enables the collections feature.- Since:
- Couchbase Server Spock (5.0)
-
PRESERVE_TTL
Enables preserving expiry when updating document.- Since:
- Couchbase Server 7.0
-
VATTR
Enables the vattr feature. Note that vattrs (such as $document) were available before this, but this flag signifies that if a vattr is requested that the server does not recognise, it will be rejected with the correct XATTR_UNKNOWN_VATTR error, rather than the connection being disconnected.- Since:
- Couchbase Server 6.5.1
-
CREATE_AS_DELETED
Enables the "create as deleted" flag, allowing a document to be created in a tombstoned state.- Since:
- Couchbase Server 6.6
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
value
public short value()Returns the actual byte value for the wire protocol.- Returns:
- the actual wire value.
-