@InterfaceStability.Committed @InterfaceAudience.Public public class SubDeleteRequest extends AbstractSubdocMutationRequest
A sub-document delete operation.
EXCEPTION_EMPTY_PATH, EXCEPTION_NULL_PATH
DEFAULT_PARTITION
Constructor and Description |
---|
SubDeleteRequest(String key,
String path,
String bucket)
Creates a new
SubDeleteRequest . |
SubDeleteRequest(String key,
String path,
String bucket,
int expiration,
long cas)
Creates a new
SubDeleteRequest . |
Modifier and Type | Method and Description |
---|---|
byte |
opcode() |
cas, createDocument, createDocument, createIntermediaryPath, createIntermediaryPath, expiration, fragment, insertDocument, insertDocument, upsertDocument, upsertDocument, xattr, xattr
cleanUpAndThrow, content, createContent, path, pathLength
key, keyBytes, opaque, partition, partition
bucket, creationTime, dispatchHostname, dispatchHostname, incrementRetryCount, isActive, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, subscriber, toString, username
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
content, path, pathLength
key, keyBytes, opaque, partition, partition
bucket, dispatchHostname, dispatchHostname, incrementRetryCount, isActive, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, subscriber, username
creationTime
public SubDeleteRequest(String key, String path, String bucket, int expiration, long cas)
Creates a new SubDeleteRequest
.
key
- the key of the document.path
- the subdocument path to delete from the document.bucket
- the bucket of the document.expiration
- the TTL of the whole enclosing document.cas
- the cas value for the operationNullPointerException
- if the path is null (see AbstractSubdocRequest.EXCEPTION_NULL_PATH
)IllegalArgumentException
- if the path is empty (see AbstractSubdocRequest.EXCEPTION_EMPTY_PATH
)public SubDeleteRequest(String key, String path, String bucket)
Creates a new SubDeleteRequest
.
key
- the key of the document.path
- the subdocument path to delete from the document.bucket
- the bucket of the document.NullPointerException
- if the path is null (see AbstractSubdocRequest.EXCEPTION_NULL_PATH
)IllegalArgumentException
- if the path is empty (see AbstractSubdocRequest.EXCEPTION_EMPTY_PATH
)Copyright © 2017 Couchbase, Inc.. All rights reserved.