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. val cas: Long
    Definition Classes
    MutateInResult → HasDurabilityTokens
  2. 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

  3. val id: String
  4. val mutationToken: Option[MutationToken]
    Definition Classes
    MutateInResult → HasDurabilityTokens
  5. def productElementNames: Iterator[String]
    Definition Classes
    Product