Package com.couchbase.client.core.msg.kv
Class SubdocMutateRequest
- java.lang.Object
-
- com.couchbase.client.core.msg.BaseRequest<R>
-
- com.couchbase.client.core.msg.kv.BaseKeyValueRequest<SubdocMutateResponse>
-
- com.couchbase.client.core.msg.kv.SubdocMutateRequest
-
- All Implemented Interfaces:
KeyValueRequest<SubdocMutateResponse>,SyncDurabilityRequest,Request<SubdocMutateResponse>,ScopedRequest
public class SubdocMutateRequest extends BaseKeyValueRequest<SubdocMutateResponse> implements SyncDurabilityRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubdocMutateRequest.Command
-
Field Summary
Fields Modifier and Type Field Description static byteSUBDOC_DOC_FLAG_ACCESS_DELETEDstatic byteSUBDOC_DOC_FLAG_CREATE_AS_DELETEDstatic intSUBDOC_MAX_FIELDS
-
Constructor Summary
Constructors Constructor Description SubdocMutateRequest(Duration timeout, CoreContext ctx, CollectionIdentifier collectionIdentifier, BucketConfig bucketConfig, RetryStrategy retryStrategy, String key, boolean insertDocument, boolean upsertDocument, boolean reviveDocument, boolean accessDeleted, boolean createAsDeleted, List<SubdocMutateRequest.Command> commands, long expiration, boolean preserveExpiry, long cas, Optional<DurabilityLevel> syncReplicationType, RequestSpan span)Deprecated.Please use the other constructor instead.SubdocMutateRequest(Duration timeout, CoreContext ctx, CollectionIdentifier collectionIdentifier, BucketConfig bucketConfig, RetryStrategy retryStrategy, String key, CoreStoreSemantics storeSemantics, boolean accessDeleted, boolean createAsDeleted, List<CoreSubdocMutateCommand> commands, long expiration, boolean preserveExpiry, long cas, Optional<DurabilityLevel> syncReplicationType, RequestSpan span)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SubdocMutateResponsedecode(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.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 InvalidArgumentExceptionerrIfNoCommands(ErrorContext errorContext)static InvalidArgumentExceptionerrIfTooManyCommands(ErrorContext errorContext)booleaninsertDocument()Stringname()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.Request
absoluteTimeout, cancel, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, idempotent, requestSpan, response, retryStrategy, succeed, succeeded, target, timeout, timeoutElapsed, timeoutRegistration
-
Methods inherited from interface com.couchbase.client.core.msg.kv.SyncDurabilityRequest
applyLevelOnSpan
-
-
-
-
Field Detail
-
SUBDOC_DOC_FLAG_ACCESS_DELETED
public static final byte SUBDOC_DOC_FLAG_ACCESS_DELETED
- See Also:
- Constant Field Values
-
SUBDOC_DOC_FLAG_CREATE_AS_DELETED
public static final byte SUBDOC_DOC_FLAG_CREATE_AS_DELETED
- See Also:
- Constant Field Values
-
SUBDOC_MAX_FIELDS
public static final int SUBDOC_MAX_FIELDS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SubdocMutateRequest
public SubdocMutateRequest(Duration timeout, CoreContext ctx, CollectionIdentifier collectionIdentifier, @Nullable BucketConfig bucketConfig, RetryStrategy retryStrategy, String key, CoreStoreSemantics storeSemantics, boolean accessDeleted, boolean createAsDeleted, List<CoreSubdocMutateCommand> commands, long expiration, boolean preserveExpiry, long cas, Optional<DurabilityLevel> syncReplicationType, RequestSpan span)
-
SubdocMutateRequest
@Deprecated public SubdocMutateRequest(Duration timeout, CoreContext ctx, CollectionIdentifier collectionIdentifier, @Nullable BucketConfig bucketConfig, RetryStrategy retryStrategy, String key, boolean insertDocument, boolean upsertDocument, boolean reviveDocument, boolean accessDeleted, boolean createAsDeleted, List<SubdocMutateRequest.Command> commands, long expiration, boolean preserveExpiry, long cas, Optional<DurabilityLevel> syncReplicationType, RequestSpan span)
Deprecated.Please use the other constructor instead.
-
-
Method Detail
-
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.- Specified by:
encodein interfaceKeyValueRequest<SubdocMutateResponse>- 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 SubdocMutateResponse 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.- Specified by:
decodein interfaceKeyValueRequest<SubdocMutateResponse>- Parameters:
response- the response to decode.- Returns:
- the decoded response as the generic type R.
-
errIfNoCommands
public static InvalidArgumentException errIfNoCommands(ErrorContext errorContext)
-
errIfTooManyCommands
public static InvalidArgumentException errIfTooManyCommands(ErrorContext errorContext)
-
insertDocument
public boolean insertDocument()
-
durabilityLevel
public Optional<DurabilityLevel> durabilityLevel()
Description copied from interface:SyncDurabilityRequestReturns the durability level if present.- Specified by:
durabilityLevelin interfaceSyncDurabilityRequest
-
name
public String name()
Description copied from interface:RequestThe 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.
- Specified by:
namein interfaceRequest<SubdocMutateResponse>- Returns:
- the name of the request type.
-
-