AnalyticsOptions

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

Alphabetic
By Inheritance

Inherited

AnalyticsOptions
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

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

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 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.
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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[_]

Definition Classes
AnyRef → Any
Annotations
@native()
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 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.
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()
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.
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.
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.
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.
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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.
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from AnyRef

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
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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[_]

Definition Classes
AnyRef → Any
Annotations
@native()
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()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any

Ungrouped

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 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.
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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[_]

Definition Classes
AnyRef → Any
Annotations
@native()
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 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.
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()
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.
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.
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.
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.
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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.
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Packages

AnalyticsOptions 

Instance Constructors

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

AnalyticsOptions