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

Class NoopRequest

java.lang.Object

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

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

com.couchbase.client.core.msg.kv.NoopRequest

All Implemented Interfaces:

KeyValueRequest<NoopResponse>, Request<NoopResponse>, ScopedRequest

Direct Known Subclasses:

KvPingRequest

public class NoopRequest
extends BaseKeyValueRequest<NoopResponse>

Represents a NOOP KV Request, doing nothing. really.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
NoopRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, CollectionIdentifier collectionIdentifier)

Method Summary

Modifier and Type	Method	Description
NoopResponse	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.
boolean	idempotent()	Returns if the given request is idempotent or not.

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

bucket, collectionIdentifier, encodedKeyWithCollection, key, nextOpaque, opaque, operationId, partition, partition, 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, name, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed

Constructor Details

NoopRequest

public NoopRequest(Duration timeout,
CoreContext ctx,
RetryStrategy retryStrategy,
CollectionIdentifier collectionIdentifier)

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

idempotent

public boolean idempotent()

Description copied from interface: Request

Returns if the given request is idempotent or not.

By default, this method always returns false for data consistency reasons. Only specific idempotent operations should override this default since it impacts retry handling quite a bit. DO NOT SET THIS TO TRUE ON MUTATING OPERATIONS!

Returns:

true if idempotent.