c

com.couchbase.client.scala.kv

LookupInResult

case class LookupInResult(id: String, content: Seq[SubDocumentField], flags: Int, cas: Long, expiryTime: Option[Instant], transcoder: Transcoder) extends Product with Serializable

The results of a SubDocument 'lookupIn' operation.

When doing a lookupIn the application provides a sequence of LookupInSpec. 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

expiryTime

the document's expiration time, if it was fetched with the withExpiry flag set. If that flag was not set, this will be None. The time is the point in time when the document expires.

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

Instance Constructors

  1. new LookupInResult(id: String, content: Seq[SubDocumentField], flags: Int, cas: Long, expiryTime: Option[Instant], transcoder: Transcoder)

    id

    the unique identifier of the document

    cas

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

    expiryTime

    the document's expiration time, if it was fetched with the withExpiry flag set. If that flag was not set, this will be None. The time is the point in time when the document expires.

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
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def contentAs[T](index: Int)(implicit deserializer: JsonDeserializer[T], tag: scala.reflect.api.JavaUniverse.WeakTypeTag[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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. 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

  10. 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.

  11. val expiryTime: Option[Instant]
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. val id: String
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. val transcoder: Transcoder
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped