Package com.couchbase.client.core.message.kv.subdoc.multi

Class SubMultiLookupRequest

java.lang.Object

com.couchbase.client.core.message.AbstractCouchbaseRequest

com.couchbase.client.core.message.kv.AbstractKeyValueRequest

com.couchbase.client.core.message.kv.subdoc.multi.SubMultiLookupRequest

All Implemented Interfaces:

CouchbaseMessage, CouchbaseRequest, BinaryRequest, BinarySubdocMultiLookupRequest

@Committed
@Public
public class SubMultiLookupRequest
extends AbstractKeyValueRequest
implements BinarySubdocMultiLookupRequest

Concrete implementation of a BinarySubdocMultiLookupRequest.

Since:

1.2

Author:

Simon Baslé

Field Summary

Fields inherited from class com.couchbase.client.core.message.kv.AbstractKeyValueRequest

DEFAULT_PARTITION

Constructor Summary

Constructors

Constructor	Description
SubMultiLookupRequest(String key, String bucket, LookupCommand... commands)	Creates a new SubMultiLookupRequest.
SubMultiLookupRequest(String key, String bucket, SubMultiLookupDocOptionsBuilder docOptionsBuilder, LookupCommand... commands)	Creates a new SubMultiLookupRequest.

Method Summary

Modifier and Type	Method	Description
List<LookupCommand>	commands()
ByteBuf	content()	The ByteBuf representing the whole list of BinarySubdocMultiLookupRequest.commands().
byte	docFlags()

Methods inherited from class com.couchbase.client.core.message.kv.AbstractKeyValueRequest

afterSpanSet, key, keyBytes, opaque, operationId, partition, partition

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

key, keyBytes, opaque, partition, partition

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 Detail

SubMultiLookupRequest

public SubMultiLookupRequest(String key,
                             String bucket,
                             SubMultiLookupDocOptionsBuilder docOptionsBuilder,
                             LookupCommand... commands)

Creates a new SubMultiLookupRequest.

Parameters:

key - the key of the document to look into.

bucket - the bucket of the document.

docOptionsBuilder - the document access options

commands - LookupCommand commands

SubMultiLookupRequest

public SubMultiLookupRequest(String key,
                             String bucket,
                             LookupCommand... commands)

Creates a new SubMultiLookupRequest.

Parameters:

key - the key of the document to look into.

bucket - the bucket of the document.

commands - LookupCommand commands

Method Detail

commands

public List<LookupCommand> commands()

Specified by:

commands in interface BinarySubdocMultiLookupRequest

Returns:

a list of the LookupCommand describing the multiple operations to apply.

content

public ByteBuf content()

Description copied from interface: BinarySubdocMultiLookupRequest

The ByteBuf representing the whole list of BinarySubdocMultiLookupRequest.commands(). This buffer is to be automatically released once the message has been written on the wire.

Specified by:

content in interface BinarySubdocMultiLookupRequest

Returns:

the ByteBuf to serve as a memcached protocol message body.

docFlags

public byte docFlags()

Specified by:

docFlags in interface BinarySubdocMultiLookupRequest

Returns:

the document flags for the Request