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

Class RangeScanCreateRequest

java.lang.Object

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

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

com.couchbase.client.core.msg.kv.PredeterminedPartitionRequest<RangeScanCreateResponse>

com.couchbase.client.core.msg.kv.RangeScanCreateRequest

All Implemented Interfaces:

KeyValueRequest<RangeScanCreateResponse>, Request<RangeScanCreateResponse>, ScopedRequest

public class RangeScanCreateRequest
extends PredeterminedPartitionRequest<RangeScanCreateResponse>

Method Summary

Modifier and Type	Method	Description
RangeScanCreateResponse	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.
static RangeScanCreateRequest	forRangeScan(byte[] startTerm, CoreRangeScan rangeScan, CoreScanOptions options, short partition, CoreContext ctx, CollectionIdentifier collectionIdentifier, Map<Short,MutationToken> consistencyMap)
static RangeScanCreateRequest	forSamplingScan(CoreSamplingScan samplingScan, CoreScanOptions options, short partition, CoreContext ctx, CollectionIdentifier collectionIdentifier, Map<Short,MutationToken> consistencyMap)
boolean	idempotent()	Returns if the given request is idempotent or not.
String	toString()

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

partition, partition

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

bucket, collectionIdentifier, encodedExternalKeyWithCollection, encodedKeyWithCollection, errorCode, indicateRejectedWithNotMyVbucket, key, nextOpaque, opaque, operationId, 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, wait, wait, wait

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

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

Method Details

forRangeScan

public static RangeScanCreateRequest forRangeScan(byte[] startTerm,
 CoreRangeScan rangeScan,
 CoreScanOptions options,
 short partition,
 CoreContext ctx,
 CollectionIdentifier collectionIdentifier,
 Map<Short,MutationToken> consistencyMap)

forSamplingScan

public static RangeScanCreateRequest forSamplingScan(CoreSamplingScan samplingScan,
 CoreScanOptions options,
 short partition,
 CoreContext ctx,
 CollectionIdentifier collectionIdentifier,
 Map<Short,MutationToken> consistencyMap)

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

toString

public String toString()

Overrides:

toString in class Object