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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RangeScanCreateResponsedecode(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.ByteBufencode(com.couchbase.client.core.deps.io.netty.buffer.ByteBufAllocator alloc, int opaque, KeyValueChannelContext ctx)Encode this request with the given allocator and opaque.static RangeScanCreateRequestforRangeScan(byte[] startTerm, boolean startExclusive, byte[] endTerm, boolean endExclusive, boolean keyOnly, Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, CollectionIdentifier collectionIdentifier, RequestSpan span, short partition, Optional<MutationToken> mutationToken)static RangeScanCreateRequestforSamplingScan(long limit, Optional<Long> seed, boolean keyOnly, Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, CollectionIdentifier collectionIdentifier, RequestSpan span, short partition, Optional<MutationToken> mutationToken)booleanidempotent()Returns if the given request is idempotent or not.StringtoString()-
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 Detail
-
forRangeScan
public static RangeScanCreateRequest forRangeScan(byte[] startTerm, boolean startExclusive, byte[] endTerm, boolean endExclusive, boolean keyOnly, Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, CollectionIdentifier collectionIdentifier, RequestSpan span, short partition, Optional<MutationToken> mutationToken)
-
forSamplingScan
public static RangeScanCreateRequest forSamplingScan(long limit, Optional<Long> seed, boolean keyOnly, Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, CollectionIdentifier collectionIdentifier, RequestSpan span, short partition, Optional<MutationToken> mutationToken)
-
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:KeyValueRequestEncode 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:KeyValueRequestDecode 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:RequestReturns 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.
-
-