case class ViewOptions(namespace: Option[DesignDocumentNamespace] = None, reduce: Option[Boolean] = None, limit: Option[Int] = None, group: Option[Boolean] = None, groupLevel: Option[Int] = None, inclusiveEnd: Option[Boolean] = None, skip: Option[Int] = None, onError: Option[ViewErrorMode] = None, debug: Option[Boolean] = None, order: Option[ViewOrdering] = None, key: Option[String] = None, startKeyDocId: Option[String] = None, endKeyDocId: Option[String] = None, endKey: Option[String] = None, startKey: Option[String] = None, keys: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None, scanConsistency: Option[ViewScanConsistency] = None, parentSpan: Option[RequestSpan] = None) extends Product with Serializable
Customize the execution of a view.
- Since
1.0.0
- Alphabetic
- By Inheritance
- ViewOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ViewOptions(namespace: Option[DesignDocumentNamespace] = None, reduce: Option[Boolean] = None, limit: Option[Int] = None, group: Option[Boolean] = None, groupLevel: Option[Int] = None, inclusiveEnd: Option[Boolean] = None, skip: Option[Int] = None, onError: Option[ViewErrorMode] = None, debug: Option[Boolean] = None, order: Option[ViewOrdering] = None, key: Option[String] = None, startKeyDocId: Option[String] = None, endKeyDocId: Option[String] = None, endKey: Option[String] = None, startKey: Option[String] = None, keys: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None, scanConsistency: Option[ViewScanConsistency] = None, parentSpan: Option[RequestSpan] = 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def debug(value: Boolean): ViewOptions
Enable debugging on view queries.
Enable debugging on view queries.
- returns
this for further chaining
- def endKey(value: Any): ViewOptions
Specifies the key to stop returning results at.
Specifies the key to stop returning results at.
- returns
this for further chaining
- def endKeyDocId(value: String): ViewOptions
Specifies the document id to stop returning results at within a number of results should
endKey
have multiple entries within the index.Specifies the document id to stop returning results at within a number of results should
endKey
have multiple entries within the index.- returns
this for further chaining
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def group(value: Boolean): ViewOptions
Group the results using the reduce function to a group or single row.
Group the results using the reduce function to a group or single row.
Important: this setter and
groupLevel
should not be used together. It is sufficient to only set the grouping level only and use this setter in cases where you always want the highest group level implicitly.- returns
this for further chaining
- def groupLevel(level: Int): ViewOptions
Specifies the depth within the key to group results.
Specifies the depth within the key to group results.
Important: this setter and
groupLevel
should not be used together. It is sufficient to only set the grouping level only and use this setter in cases where you always want the highest group level implicitly.- returns
this for further chaining
- def inclusiveEnd(value: Boolean): ViewOptions
Specifies whether the specified end key should be included in the result.
Specifies whether the specified end key should be included in the result.
- returns
this for further chaining
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def key(value: Any): ViewOptions
Specifies a specific key to fetch from the index.
Specifies a specific key to fetch from the index.
- returns
this for further chaining
- def keys(values: Iterable[Any]): ViewOptions
Specifies a specific set of keys to fetch from the index.
Specifies a specific set of keys to fetch from the index.
- returns
this for further chaining
- def limit(value: Int): ViewOptions
Limit the number of the returned documents to the specified number.
Limit the number of the returned documents to the specified number.
- returns
this for further chaining
- def namespace(value: DesignDocumentNamespace): ViewOptions
Sets in which namespace the view exists.
Sets in which namespace the view exists.
- returns
this for further chaining
- 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 onError(value: ViewErrorMode): ViewOptions
Sets the response in the event of an error.
Sets the response in the event of an error.
- returns
this for further chaining
- def order(value: ViewOrdering): ViewOptions
Specifies the results ordering.
Specifies the results ordering. See ViewOrdering for details.
- returns
this for further chaining
- def parentSpan(value: RequestSpan): ViewOptions
Sets the parent
RequestSpan
.Sets the parent
RequestSpan
.- returns
a copy of this with the change applied, for chaining.
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def reduce(value: Boolean): ViewOptions
Explicitly enable/disable the reduce function on the query.
Explicitly enable/disable the reduce function on the query.
- returns
this for further chaining
- def retryStrategy(strategy: RetryStrategy): ViewOptions
Sets what retry strategy to use if the operation fails.
Sets what retry strategy to use if the operation fails.
- strategy
the retry strategy to use
- returns
a copy of this with the change applied, for chaining.
- def scanConsistency(scanConsistency: ViewScanConsistency): ViewOptions
Sets what scan consistency to use.
Sets what scan consistency to use. See ViewScanConsistency for details.
- scanConsistency
the scan consistency to use
- returns
a copy of this with the change applied, for chaining.
- def skip(value: Int): ViewOptions
Skip this number of records before starting to return the results.
Skip this number of records before starting to return the results.
- returns
this for further chaining
- def startKey(value: Any): ViewOptions
Specifies the key to skip to before beginning to return results.
Specifies the key to skip to before beginning to return results.
- returns
this for further chaining
- def startKeyDocId(value: String): ViewOptions
Specifies the document id to start returning results at within a number of results should
startKey
have multiple entries within the index.Specifies the document id to start returning results at within a number of results should
startKey
have multiple entries within the index.- returns
this for further chaining
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeout(timeout: Duration): ViewOptions
When to timeout the operation.
When to timeout the operation.
- returns
this for further chaining
- 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)