c

com.couchbase.client.scala.kv

LookupInReplicaResult

case class LookupInReplicaResult extends Product with Serializable

The results of a SubDocument lookupIn operation when reading from replicas.

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

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

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. def cas: Long

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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def contentAs[T](index: Int)(implicit deserializer: JsonDeserializer[T], tag: ClassTag[T]): Try[T]

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

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

    T

    this can be of any type for which an implicit com.couchbase.client.scala.codec.JsonDeserializer can be found: a list of types that are supported 'out of the box' is available at these JSON docs. For an exists operation, only an output type of Boolean is supported.

    index

    the index of the LookupInSpec provided to the lookupIn

  8. def contentAsBytes(index: Int): Try[Array[Byte]]

    Returns the raw JSON bytes of the content at the given index.

    Returns the raw JSON bytes of the content at the given index.

    Note that if the field is a string then it will be surrounded by quotation marks, as this is the raw response from the server. E.g. "foo" will return a 5-byte array.

    index

    the index of the subdoc value to retrieve.

    returns

    the JSON content as a byte array

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def exists(index: Int): Boolean

    Returns whether content has successfully been returned for a particular LookupInSpec.

    Returns whether content has successfully been returned for a particular LookupInSpec.

    Important note: be careful with the naming similarity to the exists LookupInSpec, which will return a field with this exists(idx) == true and .contentAs[Boolean](idx) == true|false

    index

    the index of the LookupInSpec provided to the lookupIn

  11. def expiry: Option[Duration]

    If the document was fetched with the withExpiry flag set then this will contain the document's expiration value.

    If the document was fetched with the withExpiry flag set then this will contain the document's expiration value. Otherwise it will be None.

    The time is expressed as a duration from the start of 'epoch time' until when the document expires.

    Also see expiryTime which also provides the expiration time, but in the form of the point of time at which the document expires.

  12. val expiryTime: Option[Instant]
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def id: String

    The unique identifier of the document.

  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val isReplica: Boolean
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. def productIterator: Iterator[Any]
    Definition Classes
    Product
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. 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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped