@InterfaceStability.Committed @InterfaceAudience.Public public interface BinarySubdocRequest extends BinaryRequest
A type of BinaryRequest
that 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 path()
.
Modifier and Type | Method and Description |
---|---|
io.netty.buffer.ByteBuf |
content()
The
ByteBuf bearing the full content for this request. |
byte |
opcode() |
String |
path()
Returns the path inside a JSON document where values will be obtained/mutated.
|
int |
pathLength() |
key, keyBytes, opaque, partition, partition
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
creationTime
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.
int pathLength()
content()
(can serve as an offset from 0 to find the path in the content).byte opcode()
KeyValueHandler.OP_SUB_GET and other OP_SUB_ constants for the list of opcodes
io.netty.buffer.ByteBuf content()
The ByteBuf
bearing 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.
Copyright © 2018 Couchbase, Inc.. All rights reserved.