- All Known Subinterfaces:
- All Known Implementing Classes:
@Committed @Public public interface BinarySubdocRequest extends BinaryRequestA type of
BinaryRequestthat deals with getting or mutating parts of a JSON document, aka a Sub-Document. The part that is to be considered is represented by the
- Simon Baslé
All Methods Instance Methods Abstract Methods Modifier and Type Method Description
ByteBufbearing the full content for this request.
path()Returns the **path** inside a JSON document where values will be obtained/mutated.
Methods inherited from interface com.couchbase.client.core.message.kv.BinaryRequest
key, keyBytes, opaque, partition, partition
Methods inherited from interface com.couchbase.client.core.message.CouchbaseRequest
bucket, complete, dispatchHostname, dispatchHostname, emit, fail, incrementRetryCount, isActive, lastLocalId, lastLocalId, lastLocalSocket, lastLocalSocket, lastRemoteSocket, lastRemoteSocket, maxRetryDuration, maxRetryDuration, observable, operationId, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, span, span, subscriber, succeed, username
String path()Returns the **path** inside a JSON document where values will be obtained/mutated. Some sub-document operations authorize the use of an empty path while other don't.
- the path to work from inside the JSON document.
- the length of the path as encoded in the
content()(can serve as an offset from 0 to find the path in the content).
- the opcode of the operation
- See Also:
KeyValueHandler.OP_SUB_GET and other OP_SUB_ constants for the list of opcodes
ByteBufbearing the full content for this request. The content is at a minimum comprised of the
path()as UTF8 bytes, and can also have any other relevant payload appended (eg. a JSON fragment for mutative operations, see
BinarySubdocMutationRequest.fragment()). This buffer is to be automatically released once the message has been written on the wire.
- the ByteBuf to serve as a memcached protocol message body.