c

com.couchbase.client.scala.kv

MutateInResult

case class MutateInResult(id: String, content: CoreSubdocMutateResult, cas: Long, mutationToken: Option[MutationToken]) extends HasDurabilityTokens with Product with Serializable

The results of a SubDocument mutateIn operation.

When doing a mutateIn the application provides a sequence of MutateInSpec. The indexes into this sequence are used when retrieving the results.

id

the unique identifier of the document

cas

the document's CAS value at the time of the lookup

mutationToken

if the com.couchbase.client.scala.env.ClusterEnvironment's ioConfig() .mutationTokensEnabled() field is true (which is recommended), this will contain a MutationToken providing additional context on the mutation.

Linear Supertypes
Serializable, Product, Equals, HasDurabilityTokens, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutateInResult
  2. Serializable
  3. Product
  4. Equals
  5. HasDurabilityTokens
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MutateInResult(id: String, content: CoreSubdocMutateResult, cas: Long, mutationToken: Option[MutationToken])

    id

    the unique identifier of the document

    cas

    the document's CAS value at the time of the lookup

    mutationToken

    if the com.couchbase.client.scala.env.ClusterEnvironment's ioConfig() .mutationTokensEnabled() field is true (which is recommended), this will contain a MutationToken providing additional context on the mutation.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val cas: Long
    Definition Classes
    MutateInResult → HasDurabilityTokens
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def contentAs[T](index: Int)(implicit deserializer: JsonDeserializer[T]): Try[T]

    Retrieve the content returned for a particular MutateInSpec, converted into the application's preferred representation.

    Retrieve the content returned for a particular MutateInSpec, converted into the application's preferred representation.

    This is only applicable for counter operations, which return the content of the counter post-mutation.

    T

    as this is only applicable for counters, the application should pass T=Long

    index

    the index of the MutateInSpec provided to the mutateIn

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. val id: String
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val mutationToken: Option[MutationToken]
    Definition Classes
    MutateInResult → HasDurabilityTokens
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. def productElementNames: Iterator[String]
    Definition Classes
    Product
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasDurabilityTokens

Inherited from AnyRef

Inherited from Any

Ungrouped