case class ScanResult(id: String, idOnly: Boolean, content: Option[Array[Byte]], flags: Int, cas: Option[Long], expiryTime: Option[Instant], transcoder: Transcoder) extends Product with Serializable

A KV range scan operation will return a stream of these.

id

the unique identifier of the document

idOnly

whether the scan was initiated with idsOnly set. If so, only the id field is present.

cas

the document's CAS value at the time of the lookup. Will not be present if the scan was performed with idsOnly set.

expiryTime

the document's expiration time, if it was fetched without the idsOnly 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, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScanResult
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ScanResult(id: String, idOnly: Boolean, content: Option[Array[Byte]], flags: Int, cas: Option[Long], expiryTime: Option[Instant], transcoder: Transcoder)

    id

    the unique identifier of the document

    idOnly

    whether the scan was initiated with idsOnly set. If so, only the id field is present.

    cas

    the document's CAS value at the time of the lookup. Will not be present if the scan was performed with idsOnly set.

    expiryTime

    the document's expiration time, if it was fetched without the idsOnly 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: Option[Long]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def contentAs[T](implicit deserializer: JsonDeserializer[T], tag: ClassTag[T]): Try[T]

    Return the content, converted into the application's preferred representation.

    Return the content, 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

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def expiry: Option[Duration]

    If the scan was initiated without the idsOnly flag set then this will contain the document's expiration value.

    If the scan was initiated without the idsOnly 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.

  10. val expiryTime: Option[Instant]
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. val id: String
  13. val idOnly: Boolean
  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. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. def productIterator: Iterator[Any]
    Definition Classes
    Product
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. val transcoder: Transcoder
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. 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