case class LookupInResult 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.
- Alphabetic
- By Inheritance
- LookupInResult
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def cas: Long
The document's CAS value at the time of the lookup.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- 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 anexists
operation, only an output type ofBoolean
is supported.- index
the index of the LookupInSpec provided to the
lookupIn
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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 thisexists(idx) == true
and.contentAs[Boolean](idx) == true|false
- index
the index of the LookupInSpec provided to the
lookupIn
- 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.
- val expiryTime: Option[Instant]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def id: String
The unique identifier of the document.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val transcoder: Transcoder
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)