com.couchbase.client.core.message.kv.subdoc.simple

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

@InterfaceStability.Committed
 @InterfaceAudience.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 and Description
SubGetRequest(String key, String path, String bucket) Creates a new SubGetRequest.

Method Summary

Modifier and Type	Method and 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

key, keyBytes, opaque, partition, partition

Methods inherited from class com.couchbase.client.core.message.AbstractCouchbaseRequest

bucket, creationTime, dispatchHostname, dispatchHostname, incrementRetryCount, isActive, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, subscriber, 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

key, keyBytes, opaque, partition, partition

Methods inherited from interface com.couchbase.client.core.message.CouchbaseRequest

bucket, dispatchHostname, dispatchHostname, incrementRetryCount, isActive, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, subscriber, username

Methods inherited from interface com.couchbase.client.core.message.CouchbaseMessage

creationTime

Constructor Detail

SubGetRequest

public SubGetRequest(String key,
                     String path,
                     String bucket)

Creates a new SubGetRequest.

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 (see AbstractSubdocRequest.EXCEPTION_NULL_PATH)

IllegalArgumentException - if the path is empty (see AbstractSubdocRequest.EXCEPTION_EMPTY_PATH)

Method Detail

opcode

public byte opcode()

Returns:

KeyValueHandler.OP_SUB_GET

See Also:

KeyValueHandler.OP_SUB_GET and other OP_SUB_ constants for the list of opcodes

xattr

public boolean xattr()

xattr

public void xattr(boolean xattr)

accessDeleted

public boolean accessDeleted()

accessDeleted

public void accessDeleted(boolean accessDeleted)