case class ScanOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, idsOnly: Option[Boolean] = None, consistentWith: Option[MutationState] = None, batchByteLimit: Option[Int] = None, batchItemLimit: Option[Int] = None) extends Product with Serializable
Provides control over how a KV range scan is performed.
- Alphabetic
- By Inheritance
- ScanOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ScanOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None, idsOnly: Option[Boolean] = None, consistentWith: Option[MutationState] = None, batchByteLimit: Option[Int] = None, batchItemLimit: Option[Int] = None)
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 batchByteLimit(value: Int): ScanOptions
Controls how many bytes are sent from the server to the client on each partition batch.
Controls how many bytes are sent from the server to the client on each partition batch.
If both this and
batchItemLimitare set, the lowest wins.- returns
a copy of this with the change applied, for chaining.
- def batchItemLimit(value: Int): ScanOptions
Controls how many documents are sent from the server to the client on each partition batch.
Controls how many documents are sent from the server to the client on each partition batch.
If both this and
batchByteLimitare set, the lowest wins.- returns
a copy of this with the change applied, for chaining.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def consistentWith(value: MutationState): ScanOptions
The KV range scan will wait until this mutation has been consistently applied.
The KV range scan will wait until this mutation has been consistently applied.
- returns
a copy of this with the change applied, for chaining.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def idsOnly(value: Boolean): ScanOptions
Just returns each document's id - not the CAS, expiry or content.
Just returns each document's id - not the CAS, expiry or content.
- returns
a copy of this with the change applied, for chaining.
- 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
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def parentSpan(value: Option[RequestSpan]): ScanOptions
Changes the parent span setting used for this operation.
Changes the parent span setting used for this operation.
This allows tracing requests through a full distributed system.
This Option-overload is provided as a convenience to help with chaining.
- returns
a copy of this with the change applied, for chaining.
- def parentSpan(value: RequestSpan): ScanOptions
Changes the parent span setting used for this operation.
Changes the parent span setting used for this operation.
This allows tracing requests through a full distributed system.
- returns
a copy of this with the change applied, for chaining.
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def retryStrategy(value: RetryStrategy): ScanOptions
Provides some control over how the SDK handles failures.
Provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment, which by default isBestEffortRetryStrategy; this will automatically retry some operations (e.g. non-mutating ones, or mutating operations that have unambiguously failed before they mutated state) until the chosen timeout.- returns
a copy of this with the change applied, for chaining.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeout(value: Duration): ScanOptions
Changes the timeout setting used for this operation.
Changes the timeout setting used for this operation.
When the operation will timeout. This will default to
timeoutConfig().kvScanTimeout()in the com.couchbase.client.scala.env.ClusterEnvironment.- returns
a copy of this with the change applied, for chaining.
- def transcoder(value: Transcoder): ScanOptions
Changes the transcoder used for this operation.
Changes the transcoder used for this operation.
The transcoder provides control over how JSON is converted in the returned
ScanResult.If not specified it will default to to
transcoder()in the com.couchbase.client.scala.env.ClusterEnvironment.- returns
a copy of this with the change applied, for chaining.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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]) @native()