Class SubGetRequest
java.lang.Object
com.couchbase.client.core.message.AbstractCouchbaseRequest
com.couchbase.client.core.message.kv.AbstractKeyValueRequest
com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocRequest
com.couchbase.client.core.message.kv.subdoc.simple.SubGetRequest
- All Implemented Interfaces:
CouchbaseMessage
,CouchbaseRequest
,BinaryRequest
,BinarySubdocRequest
@Committed @Public public class SubGetRequest extends AbstractSubdocRequest
A sub-document get operation.
- Since:
- 1.2
- Author:
- Simon Baslé
-
Field Summary
Fields inherited from class com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocRequest
EXCEPTION_EMPTY_PATH, EXCEPTION_NULL_PATH
Fields inherited from class com.couchbase.client.core.message.kv.AbstractKeyValueRequest
DEFAULT_PARTITION
-
Constructor Summary
Constructors Constructor Description SubGetRequest(String key, String path, String bucket)
Creates a newSubGetRequest
. -
Method Summary
Modifier and Type Method Description boolean
accessDeleted()
void
accessDeleted(boolean accessDeleted)
byte
opcode()
boolean
xattr()
void
xattr(boolean xattr)
Methods inherited from class com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocRequest
cleanUpAndThrow, content, createContent, path, pathLength
Methods inherited from class com.couchbase.client.core.message.kv.AbstractKeyValueRequest
afterSpanSet, hasSeenNotMyVbucket, key, keyBytes, opaque, operationId, partition, partition, sawNotMyVbucket
Methods inherited from class com.couchbase.client.core.message.AbstractCouchbaseRequest
bucket, complete, creationTime, dispatchHostname, dispatchHostname, emit, fail, incrementRetryCount, isActive, lastLocalId, lastLocalId, lastLocalSocket, lastLocalSocket, lastRemoteSocket, lastRemoteSocket, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, span, span, subscriber, succeed, toString, username
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.couchbase.client.core.message.kv.BinaryRequest
hasSeenNotMyVbucket, key, keyBytes, opaque, partition, partition, sawNotMyVbucket
Methods inherited from interface com.couchbase.client.core.message.CouchbaseMessage
creationTime
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
-
Constructor Details
-
SubGetRequest
Creates a newSubGetRequest
.- Parameters:
key
- the key of the document.path
- the subdocument path to consider inside the document.bucket
- the bucket of the document.- Throws:
NullPointerException
- if the path is null (seeAbstractSubdocRequest.EXCEPTION_NULL_PATH
)IllegalArgumentException
- if the path is empty (seeAbstractSubdocRequest.EXCEPTION_EMPTY_PATH
)
-
-
Method Details
-
opcode
public byte opcode() -
xattr
public boolean xattr() -
xattr
public void xattr(boolean xattr) -
accessDeleted
public boolean accessDeleted() -
accessDeleted
public void accessDeleted(boolean accessDeleted)
-