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

Class ReplaceRequest

java.lang.Object

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

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

com.couchbase.client.core.msg.kv.ReplaceRequest

All Implemented Interfaces:

KeyValueRequest<ReplaceResponse>, SyncDurabilityRequest, Request<ReplaceResponse>, ScopedRequest

public class ReplaceRequest
extends BaseKeyValueRequest<ReplaceResponse>
implements SyncDurabilityRequest

Uses the KV replace command to replace a document if it exists.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
ReplaceRequest(String key, byte[] content, long expiration, boolean preserveExpiry, int flags, Duration timeout, long cas, CoreContext ctx, CollectionIdentifier collectionIdentifier, RetryStrategy retryStrategy, Optional<DurabilityLevel> syncReplicationType, RequestSpan span)

Method Summary

Modifier and Type	Method	Description
ReplaceResponse	decode(com.couchbase.client.core.deps.io.netty.buffer.ByteBuf response, KeyValueChannelContext ctx)	Decode the encoded response into its message representation.
Optional<DurabilityLevel>	durabilityLevel()	Returns the durability level if present.
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, 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

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, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, idempotent, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed

Constructor Details

ReplaceRequest

public ReplaceRequest(String key,
byte[] content,
long expiration,
boolean preserveExpiry,
int flags,
Duration timeout,
long cas,
CoreContext ctx,
CollectionIdentifier collectionIdentifier,
RetryStrategy retryStrategy,
Optional<DurabilityLevel> syncReplicationType,
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.

Specified by:

encode in interface KeyValueRequest<ReplaceResponse>

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 ReplaceResponse 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.

Specified by:

decode in interface KeyValueRequest<ReplaceResponse>

Parameters:

response - the response to decode.

Returns:

the decoded response as the generic type R.

durabilityLevel

public Optional<DurabilityLevel> durabilityLevel()

Description copied from interface: SyncDurabilityRequest

Returns the durability level if present.

Specified by:

durabilityLevel in interface SyncDurabilityRequest

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 => foo), but if that does not match up it should be overridden in the actual class.

Specified by:

name in interface Request<ReplaceResponse>

Returns:

the name of the request type.