case class ScanResult extends Product with Serializable

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

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

Value Members

  1. def cas: Option[Long]

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

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

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

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

  4. def expiryTime: Option[Instant]

    The document's expiration time, if it was fetched without the idsOnly flag set.

    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.

  5. def id: String

    The unique identifier of the document.

  6. def idOnly: Boolean

    Whether the scan was initiated with idsOnly set.

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

  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. val transcoder: Transcoder