Package com.couchbase.client.core.message.kv.subdoc.simple

Class SubCounterRequest

java.lang.Object

com.couchbase.client.core.message.AbstractCouchbaseRequest

com.couchbase.client.core.message.kv.AbstractKeyValueRequest

com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocRequest

com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocMutationRequest

com.couchbase.client.core.message.kv.subdoc.simple.SubCounterRequest

All Implemented Interfaces:

CouchbaseMessage, CouchbaseRequest, BinaryRequest, BinarySubdocMutationRequest, BinarySubdocRequest

@Committed
@Public
public class SubCounterRequest
extends AbstractSubdocMutationRequest

A sub-document counter operation.

Since:

1.2

Author:

Simon Baslé

Field Summary

Fields inherited from class com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocRequest

EXCEPTION_EMPTY_PATH, EXCEPTION_NULL_PATH

Fields inherited from class com.couchbase.client.core.message.kv.AbstractKeyValueRequest

DEFAULT_PARTITION

Constructor Summary

Constructors

Constructor	Description
SubCounterRequest(String key, String path, long delta, String bucket)	Creates a new SubCounterRequest.
SubCounterRequest(String key, String path, long delta, String bucket, int expiration, long cas)	Creates a new SubCounterRequest.

Method Summary

Modifier and Type	Method	Description
byte	opcode()

Methods inherited from class com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocMutationRequest

cas, createDocument, createDocument, createIntermediaryPath, createIntermediaryPath, expandMacros, expandMacros, expiration, fragment, insertDocument, insertDocument, upsertDocument, upsertDocument, xattr, xattr

Methods inherited from class com.couchbase.client.core.message.kv.subdoc.simple.AbstractSubdocRequest

cleanUpAndThrow, content, createContent, path, pathLength

Methods inherited from class com.couchbase.client.core.message.kv.AbstractKeyValueRequest

afterSpanSet, key, keyBytes, opaque, operationId, partition, partition

Methods inherited from class com.couchbase.client.core.message.AbstractCouchbaseRequest

bucket, complete, creationTime, dispatchHostname, dispatchHostname, emit, fail, incrementRetryCount, isActive, lastLocalId, lastLocalId, lastLocalSocket, lastLocalSocket, lastRemoteSocket, lastRemoteSocket, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, span, span, subscriber, succeed, toString, username

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.message.kv.BinaryRequest

key, keyBytes, opaque, partition, partition

Methods inherited from interface com.couchbase.client.core.message.kv.subdoc.BinarySubdocRequest

content, path, pathLength

Methods inherited from interface com.couchbase.client.core.message.CouchbaseMessage

creationTime

Methods inherited from interface com.couchbase.client.core.message.CouchbaseRequest

bucket, complete, dispatchHostname, dispatchHostname, emit, fail, incrementRetryCount, isActive, lastLocalId, lastLocalId, lastLocalSocket, lastLocalSocket, lastRemoteSocket, lastRemoteSocket, maxRetryDuration, maxRetryDuration, observable, operationId, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, span, span, subscriber, succeed, username

Constructor Detail

SubCounterRequest

public SubCounterRequest(String key,
                         String path,
                         long delta,
                         String bucket,
                         int expiration,
                         long cas)

Creates a new SubCounterRequest.

Parameters:

key - the key of the document.

path - the subdocument path to consider inside the document. If the last element doesn't exist it will be created, and delta will be applied as if it was 0.

delta - the negative or positive value to add to the integer value at the path.

bucket - the bucket of the document.

expiration - the TTL of the whole enclosing document.

cas - the cas value for the operation

Throws:

NullPointerException - if the path is null (see AbstractSubdocRequest.EXCEPTION_NULL_PATH)

IllegalArgumentException - if the path is empty (see AbstractSubdocRequest.EXCEPTION_EMPTY_PATH)

SubCounterRequest

public SubCounterRequest(String key,
                         String path,
                         long delta,
                         String bucket)

Creates a new SubCounterRequest.

Parameters:

key - the key of the document.

path - the subdocument path to consider inside the document. If the last element doesn't exist it will be created, and delta will be applied as if it was 0.

delta - the negative or positive value to add to the integer value at the path.

bucket - the bucket of the document.

Throws:

NullPointerException - if the path is null (see AbstractSubdocRequest.EXCEPTION_NULL_PATH)

IllegalArgumentException - if the path is empty (see AbstractSubdocRequest.EXCEPTION_EMPTY_PATH)

Method Detail

opcode

public byte opcode()

Returns:

KeyValueHandler.OP_SUB_COUNTER

See Also:

KeyValueHandler.OP_SUB_GET and other OP_SUB_ constants for the list of opcodes