Package com.couchbase.client.java.kv
Class MutationResult
- java.lang.Object
-
- com.couchbase.client.java.kv.MutationResult
-
- Direct Known Subclasses:
CounterResult,MutateInResult
public class MutationResult extends Object
Result returned from all kinds of Key-Value mutation operations.- Since:
- 3.0.0
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description longcas()Returns the new CAS value of the document after it has been modified successfully.booleanequals(Object o)inthashCode()Optional<MutationToken>mutationToken()Returns theMutationTokenof the document after the performed mutation.StringtoString()
-
-
-
Method Detail
-
cas
public long cas()
Returns the new CAS value of the document after it has been modified successfully.The CAS value is an opaque identifier which is associated with a specific state of the document on the server. It can be used during a subsequent mutation to make sure that the document has not been modified in the meantime.
If document on the server has been modified in the meantime the SDK will raise a
CasMismatchException. In this case the caller is expected to re-do the whole "fetch-modify-update" cycle again. Please refer to the SDK documentation for more information on CAS mismatches and subsequent retries.
-
mutationToken
public Optional<MutationToken> mutationToken()
Returns theMutationTokenof the document after the performed mutation.Note that this value is only present if mutation tokens have been enabled on the environment configuration.
-
-