AnalyticsOptions
in package
Tags
Table of Contents
- $clientContextId : string|null
- $namedParameters : array<string|int, mixed>|null
- $parentSpan : RequestSpan|null
- $positionalParameters : array<string|int, mixed>|null
- $priority : bool|null
- $raw : array<string|int, mixed>|null
- $readonly : bool|null
- $scanConsistency : string|null
- $timeoutMilliseconds : int|null
- $transcoder : Transcoder
- __construct() : mixed
- build() : AnalyticsOptions
- Static helper to keep code more readable
- clientContextId() : AnalyticsOptions
- Sets the client context id for this query.
- export() : array<string|int, mixed>
- getTranscoder() : Transcoder
- Returns associated transcoder.
- namedParameters() : AnalyticsOptions
- Sets the named parameters for this query.
- parentSpan() : AnalyticsOptions
- Sets the parent span.
- positionalParameters() : AnalyticsOptions
- Sets the positional parameters for this query.
- priority() : AnalyticsOptions
- Sets whether this query should be assigned as high priority by the analytics engine.
- raw() : AnalyticsOptions
- Sets any extra query parameters that the SDK does not provide an option for.
- readonly() : AnalyticsOptions
- Sets whether this query should be readonly.
- scanConsistency() : AnalyticsOptions
- Sets the scan consistency.
- timeout() : AnalyticsOptions
- Sets the operation timeout in milliseconds.
- transcoder() : AnalyticsOptions
- Associate custom transcoder with the request.
Properties
$clientContextId
private
string|null
$clientContextId
= null
$namedParameters
private
array<string|int, mixed>|null
$namedParameters
= null
$parentSpan
private
RequestSpan|null
$parentSpan
= null
$positionalParameters
private
array<string|int, mixed>|null
$positionalParameters
= null
$priority
private
bool|null
$priority
= null
$raw
private
array<string|int, mixed>|null
$raw
= null
$readonly
private
bool|null
$readonly
= null
$scanConsistency
private
string|null
$scanConsistency
= null
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
$transcoder
private
Transcoder
$transcoder
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —build()
Static helper to keep code more readable
public
static build() : AnalyticsOptions
Tags
Return values
AnalyticsOptions —clientContextId()
Sets the client context id for this query.
public
clientContextId(string $id) : AnalyticsOptions
Parameters
- $id : string
-
the client context id
Return values
AnalyticsOptions —export()
public
static export(AnalyticsOptions|null $options[, string|null $scopeName = null ][, string|null $bucketName = null ]) : array<string|int, mixed>
Parameters
- $options : AnalyticsOptions|null
- $scopeName : string|null = null
- $bucketName : string|null = null
Return values
array<string|int, mixed> —getTranscoder()
Returns associated transcoder.
public
static getTranscoder(AnalyticsOptions|null $options) : Transcoder
Parameters
- $options : AnalyticsOptions|null
Tags
Return values
Transcoder —namedParameters()
Sets the named parameters for this query.
public
namedParameters(array<string|int, mixed> $pairs) : AnalyticsOptions
Parameters
- $pairs : array<string|int, mixed>
-
the associative array of parameters
Return values
AnalyticsOptions —parentSpan()
Sets the parent span.
public
parentSpan(RequestSpan $parentSpan) : AnalyticsOptions
Parameters
- $parentSpan : RequestSpan
-
the parent span
Tags
Return values
AnalyticsOptions —positionalParameters()
Sets the positional parameters for this query.
public
positionalParameters(array<string|int, mixed> $params) : AnalyticsOptions
Parameters
- $params : array<string|int, mixed>
-
the array of parameters
Return values
AnalyticsOptions —priority()
Sets whether this query should be assigned as high priority by the analytics engine.
public
priority(bool $isPriority) : AnalyticsOptions
Parameters
- $isPriority : bool
-
whether this query should be assiged as high priority.
Tags
Return values
AnalyticsOptions —raw()
Sets any extra query parameters that the SDK does not provide an option for.
public
raw(string $key, string $value) : AnalyticsOptions
Parameters
- $key : string
-
the name of the parameter
- $value : string
-
the value of the parameter
Return values
AnalyticsOptions —readonly()
Sets whether this query should be readonly.
public
readonly(bool $readonly) : AnalyticsOptions
Parameters
- $readonly : bool
-
whether this query should be readonly.
Tags
Return values
AnalyticsOptions —scanConsistency()
Sets the scan consistency.
public
scanConsistency(string|int $consistencyLevel) : AnalyticsOptions
Parameters
- $consistencyLevel : string|int
-
the scan consistency level
Tags
Return values
AnalyticsOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : AnalyticsOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
AnalyticsOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : AnalyticsOptions
Parameters
- $transcoder : Transcoder