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

Interface BinarySubdocMultiLookupRequest

All Superinterfaces:

BinaryRequest, CouchbaseMessage, CouchbaseRequest

All Known Implementing Classes:

SubMultiLookupRequest

@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface BinarySubdocMultiLookupRequest
extends BinaryRequest

A BinarySubdocRequest that describes multiple lookup operations on a single document.

Each LookupCommand can act on a different path inside the document. Such a multi-operation can partially fail, as some lookup are valid while others are not.

Since:

1.2

Author:

Simon Baslé

Method Summary

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

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

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

creationTime

Method Detail

commands

List<LookupCommand> commands()

Returns:

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

docFlags

byte docFlags()

Returns:

the document flags for the Request

content

ByteBuf content()

The ByteBuf representing the whole list of commands().

This buffer is to be automatically released once the message has been written on the wire.

Returns:

the ByteBuf to serve as a memcached protocol message body.