com.couchbase.transactions

Class TransactionGetResult

java.lang.Object

com.couchbase.transactions.TransactionGetResult

public class TransactionGetResult
extends java.lang.Object

Represents a value fetched from Couchbase, along with additional transactional metadata.

Constructor Summary

Constructors

Constructor and Description
TransactionGetResult(java.lang.String id, byte[] content, long cas, com.couchbase.client.java.ReactiveCollection collection, TransactionLinks links, TransactionJsonDocumentStatus status, java.util.Optional<DocumentMetadata> documentMetadata, com.couchbase.client.java.codec.Transcoder transcoder, java.util.Optional<com.couchbase.client.java.json.JsonObject> txnMeta)

Method Summary

Modifier and Type	Method and Description
long	cas() Returns the document's CAS (compare-and-swap) value, used for optimistic concurrency.
com.couchbase.client.java.ReactiveCollection	collection()
<T> T	contentAs(java.lang.Class<T> target) Decodes the content of the document into the target class.
com.couchbase.client.java.json.JsonObject	contentAsObject() Decodes the content of the document into a JsonObject using the default decoder.
static TransactionGetResult	createFrom(com.couchbase.client.java.ReactiveCollection collection, java.lang.String id, com.couchbase.client.java.kv.LookupInResult doc, TransactionJsonDocumentStatus status, com.couchbase.client.java.codec.Transcoder transcoder)
static TransactionGetResult	createFrom(TransactionGetResult doc, byte[] content, TransactionJsonDocumentStatus status)
java.util.Optional<DocumentMetadata>	documentMetadata()
java.lang.String	id() Returns the document's ID, which must be unique across the bucket.
TransactionLinks	links()
TransactionJsonDocumentStatus	status() Deprecated. this field is now deprecated as of 1.1.3 and should no longer be used or checked by the application.
TransactionGetResult	status(TransactionJsonDocumentStatus status)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransactionGetResult

@Stability.Internal
public TransactionGetResult(java.lang.String id,
                                                @Nullable
                                                byte[] content,
                                                long cas,
                                                com.couchbase.client.java.ReactiveCollection collection,
                                                @Nullable
                                                TransactionLinks links,
                                                TransactionJsonDocumentStatus status,
                                                java.util.Optional<DocumentMetadata> documentMetadata,
                                                com.couchbase.client.java.codec.Transcoder transcoder,
                                                java.util.Optional<com.couchbase.client.java.json.JsonObject> txnMeta)

Parameters:

content - will be nullable for tombstones

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

documentMetadata

@Stability.Internal
public java.util.Optional<DocumentMetadata> documentMetadata()

links

@Stability.Internal
 @Nullable
public TransactionLinks links()

id

public java.lang.String id()

Returns the document's ID, which must be unique across the bucket.

cas

public long cas()

Returns the document's CAS (compare-and-swap) value, used for optimistic concurrency.

contentAsObject

public com.couchbase.client.java.json.JsonObject contentAsObject()

Decodes the content of the document into a JsonObject using the default decoder.

contentAs

public <T> T contentAs(java.lang.Class<T> target)

Decodes the content of the document into the target class.

Parameters:

target - the target class to decode the encoded content into.

status

@Deprecated
 @Nullable
public TransactionJsonDocumentStatus status()

Deprecated. this field is now deprecated as of 1.1.3 and should no longer be used or checked by the application.

Returns the document's status, or null if it is unavailable.

status

@Stability.Internal
public TransactionGetResult status(TransactionJsonDocumentStatus status)

createFrom

@Stability.Internal
public static TransactionGetResult createFrom(TransactionGetResult doc,
                                                                  byte[] content,
                                                                  TransactionJsonDocumentStatus status)

createFrom

@Stability.Internal
public static TransactionGetResult createFrom(com.couchbase.client.java.ReactiveCollection collection,
                                                                  java.lang.String id,
                                                                  com.couchbase.client.java.kv.LookupInResult doc,
                                                                  TransactionJsonDocumentStatus status,
                                                                  com.couchbase.client.java.codec.Transcoder transcoder)

collection

public com.couchbase.client.java.ReactiveCollection collection()