Package com.couchbase.client.core.msg.kv

Class ReplicaSubdocGetRequest

java.lang.Object

com.couchbase.client.core.msg.BaseRequest<SubdocGetResponse>

com.couchbase.client.core.msg.kv.BaseKeyValueRequest<SubdocGetResponse>

com.couchbase.client.core.msg.kv.SubdocGetRequest

com.couchbase.client.core.msg.kv.ReplicaSubdocGetRequest

All Implemented Interfaces:

KeyValueRequest<SubdocGetResponse>, Request<SubdocGetResponse>, ScopedRequest

public class ReplicaSubdocGetRequest
extends SubdocGetRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.couchbase.client.core.msg.kv.SubdocGetRequest

SubdocGetRequest.Command

Method Summary

Modifier and Type	Method	Description
static ReplicaSubdocGetRequest	create(Duration timeout, CoreContext ctx, CollectionIdentifier collectionIdentifier, RetryStrategy retryStrategy, String key, byte flags, List<CoreSubdocGetCommand> commands, short replica, RequestSpan span)
String	name()	The unique name of the request, usually related to the type but not necessarily.
int	replica()	Returns the index of the replica set member this request targets.
Map<String,Object>	serviceContext()	Returns contextual information for each individual service.

Methods inherited from class com.couchbase.client.core.msg.kv.SubdocGetRequest

convertCommandsToCore, create, decode, encode, idempotent

Methods inherited from class com.couchbase.client.core.msg.kv.BaseKeyValueRequest

bucket, collectionIdentifier, encodedExternalKeyWithCollection, encodedKeyWithCollection, errorCode, indicateRejectedWithNotMyVbucket, key, nextOpaque, opaque, operationId, partition, partition, rejectedWithNotMyVbucket, serviceType

Methods inherited from class com.couchbase.client.core.msg.BaseRequest

absoluteTimeout, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed, timeoutRegistration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.couchbase.client.core.msg.Request

absoluteTimeout, cancel, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, requestSpan, response, retryStrategy, serviceTracingId, succeed, succeeded, target, timeout, timeoutElapsed, timeoutRegistration

Method Details

create

public static ReplicaSubdocGetRequest create(Duration timeout,
 CoreContext ctx,
 CollectionIdentifier collectionIdentifier,
 RetryStrategy retryStrategy,
 String key,
 byte flags,
 List<CoreSubdocGetCommand> commands,
 short replica,
 RequestSpan span)

replica

public int replica()

Description copied from interface: KeyValueRequest

Returns the index of the replica set member this request targets.

• 0 = primary ("active")
• 1 = first replica
• 2 = second replica
• 3 = third replica

serviceContext

public Map<String,Object> serviceContext()

Description copied from interface: Request

Returns contextual information for each individual service.

Specified by:

serviceContext in interface Request<SubdocGetResponse>

Overrides:

serviceContext in class BaseKeyValueRequest<SubdocGetResponse>

Returns:

the service context.

name

public String name()

Description copied from interface: Request

The unique name of the request, usually related to the type but not necessarily.

The default implementation is derived from the class name (i.e. FooRequest returns foo), but if that does not match up it should be overridden in the actual class.

Specified by:

name in interface Request<SubdocGetResponse>

Overrides:

name in class SubdocGetRequest

Returns:

the name of the request type.