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

Class GetAndLockRequest

java.lang.Object

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

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

com.couchbase.client.core.msg.kv.GetAndLockRequest

All Implemented Interfaces:

KeyValueRequest<GetAndLockResponse>, Request<GetAndLockResponse>, ScopedRequest

public class GetAndLockRequest
extends BaseKeyValueRequest<GetAndLockResponse>

Represents a KV GetAndTouch operation.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
GetAndLockRequest(String key, Duration timeout, CoreContext ctx, CollectionIdentifier collectionIdentifier, RetryStrategy retryStrategy, Duration lockFor, RequestSpan span)

Method Summary

Modifier and Type	Method	Description
GetAndLockResponse	decode(com.couchbase.client.core.deps.io.netty.buffer.ByteBuf response, KeyValueChannelContext ctx)	Decode the encoded response into its message representation.
com.couchbase.client.core.deps.io.netty.buffer.ByteBuf	encode(com.couchbase.client.core.deps.io.netty.buffer.ByteBufAllocator alloc, int opaque, KeyValueChannelContext ctx)	Encode this request with the given allocator and opaque.
String	name()	The unique name of the request, usually related to the type but not necessarily.

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

bucket, collectionIdentifier, encodedExternalKeyWithCollection, encodedKeyWithCollection, errorCode, indicateRejectedWithNotMyVbucket, key, nextOpaque, opaque, operationId, partition, partition, rejectedWithNotMyVbucket, serviceContext, 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.kv.KeyValueRequest

replica

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

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

Constructor Details

GetAndLockRequest

public GetAndLockRequest(String key,
 Duration timeout,
 CoreContext ctx,
 CollectionIdentifier collectionIdentifier,
 RetryStrategy retryStrategy,
 Duration lockFor,
 RequestSpan span)

Method Details

encode

public com.couchbase.client.core.deps.io.netty.buffer.ByteBuf encode(com.couchbase.client.core.deps.io.netty.buffer.ByteBufAllocator alloc,
 int opaque,
 KeyValueChannelContext ctx)

Description copied from interface: KeyValueRequest

Encode this request with the given allocator and opaque.

Parameters:

alloc - the allocator where to grab the buffers from.

opaque - the opaque value to use.

ctx - more encode context.

Returns:

the encoded request as a ByteBuf.

decode

public GetAndLockResponse decode(com.couchbase.client.core.deps.io.netty.buffer.ByteBuf response,
 KeyValueChannelContext ctx)

Description copied from interface: KeyValueRequest

Decode the encoded response into its message representation.

Parameters:

response - the response to decode.

Returns:

the decoded response as the generic type R.

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.

Returns:

the name of the request type.