BinaryRequest (Couchbase JVM Core IO 1.7.14 API)

All Superinterfaces:

CouchbaseMessage, CouchbaseRequest

All Known Subinterfaces:

BinaryStoreRequest, BinarySubdocMultiLookupRequest, BinarySubdocMultiMutationRequest, BinarySubdocMutationRequest, BinarySubdocRequest

All Known Implementing Classes:

AbstractKeyValueRequest, AbstractSubdocMutationRequest, AbstractSubdocRequest, AppendRequest, CounterRequest, GetAllMutationTokensRequest, GetBucketConfigRequest, GetRequest, InsertRequest, KeyValueHandler.KeepAliveRequest, NoopRequest, ObserveRequest, ObserveSeqnoRequest, PrependRequest, RemoveRequest, ReplaceRequest, ReplicaGetRequest, StatRequest, SubArrayRequest, SubCounterRequest, SubDeleteRequest, SubDictAddRequest, SubDictUpsertRequest, SubExistRequest, SubGetCountRequest, SubGetRequest, SubMultiLookupRequest, SubMultiMutationRequest, SubReplaceRequest, TouchRequest, UnlockRequest, UpsertRequest
```
public interface BinaryRequest
extends CouchbaseRequest
```
Common marker interface for all BinaryRequests.

Since:

1.0

Author:

Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`key()`	The key of the document.
`byte[]`	`keyBytes()`	The raw byte representation of the key.
`int`	`opaque()`	A opaque value representing this request.
`short`	`partition()`	The partition (vbucket) to use for this request.
`BinaryRequest`	`partition(short id)`	Set the partition ID.

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

- Method Detail
  - key
```
String key()
```
    The key of the document.
    
    Returns:
    
    the key of the document, if set.
  - keyBytes
```
byte[] keyBytes()
```
    The raw byte representation of the key.
    
    Returns:
    
    the bytes of the key.
  - partition
```
short partition()
```
    The partition (vbucket) to use for this request.
    
    Returns:
    
    the partition to use.
  - partition
```
BinaryRequest partition(short id)
```
    Set the partition ID.
    
    Parameters:
    
    id - the id of the partition.
    
    Returns:
    
    the BinaryRequest for proper chaining.
  - opaque
```
int opaque()
```
    A opaque value representing this request.
    
    Returns:
    
    an automatically generated opaque value.