Packages

case class AnalyticsOptions(parameters: Option[AnalyticsParameters] = None, clientContextId: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None, priority: Boolean = false, readonly: Option[Boolean] = None, scanConsistency: Option[AnalyticsScanConsistency] = None, parentSpan: Option[RequestSpan] = None, raw: Option[Map[String, Any]] = None) extends Product with Serializable

Customize the execution of an analytics query.

Since

1.0.0

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AnalyticsOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AnalyticsOptions(parameters: Option[AnalyticsParameters] = None, clientContextId: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None, priority: Boolean = false, readonly: Option[Boolean] = None, scanConsistency: Option[AnalyticsScanConsistency] = None, parentSpan: Option[RequestSpan] = None, raw: Option[Map[String, Any]] = None)

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. def clientContextId(contextId: String): AnalyticsOptions

    Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

    Adds a client context ID to the request, that will be sent back in the response, allowing clients to meaningfully trace requests/responses when many are exchanged.

    returns

    a copy of this with the change applied, for chaining.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. def parameters(values: AnalyticsParameters): AnalyticsOptions

    Provides named or positional parameters, for queries parameterised that way.

    Provides named or positional parameters, for queries parameterised that way.

    See AnalyticsParameters for details.

    returns

    a copy of this with the change applied, for chaining.

  15. def parentSpan(value: RequestSpan): AnalyticsOptions

    Sets the parent RequestSpan.

    Sets the parent RequestSpan.

    returns

    a copy of this with the change applied, for chaining.

    Annotations
    @Volatile()
  16. def priority(value: Boolean): AnalyticsOptions

    Specify that this is a high-priority request.

    Specify that this is a high-priority request. The default is false.

    returns

    a copy of this with the change applied, for chaining.

  17. def raw(raw: Map[String, Any]): AnalyticsOptions

    Allows providing custom JSON key/value pairs for advanced usage.

    Allows providing custom JSON key/value pairs for advanced usage.

    If available, it is recommended to use the methods on this object to customize the query. This method should only be used if no such setter can be found (i.e. if an undocumented property should be set or you are using an older client and a new server-configuration property has been added to the cluster).

    Note that the values will be passed through a JSON encoder, so do not provide already encoded JSON as the value. If you want to pass objects or arrays, you can use JsonObject and JsonArray respectively.

    returns

    a copy of this with the change applied, for chaining.

  18. def readonly(readonly: Boolean): AnalyticsOptions

    Specify whether this is a readonly request, e.g.

    Specify whether this is a readonly request, e.g. one that performs no mutations.

    The default is false.

    returns

    a copy of this with the change applied, for chaining.

  19. def retryStrategy(retryStrategy: RetryStrategy): AnalyticsOptions

    Sets the RetryStrategy to use.

    Sets the RetryStrategy to use.

    returns

    a copy of this with the change applied, for chaining.

  20. def scanConsistency(scanConsistency: AnalyticsScanConsistency): AnalyticsOptions

    Scan consistency for the query

    Scan consistency for the query

    scanConsistency

    the index scan consistency to be used; see AnalyticsScanConsistency for details

    returns

    a copy of this with the change applied, for chaining.

  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def timeout(timeout: Duration): AnalyticsOptions

    Sets a maximum timeout for processing.

    Sets a maximum timeout for processing.

    timeout

    the duration of the timeout.

    returns

    a copy of this with the change applied, for chaining.

  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped