Documentation

AnalyticsOptions
in package

Tags
since
4.0.0

Table of Contents

$clientContextId  : string|null
$namedParameters  : array<string|int, mixed>|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.
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

$namedParameters

private array<string|int, mixed>|null $namedParameters = null

$positionalParameters

private array<string|int, mixed>|null $positionalParameters = null

Methods

__construct()

public __construct() : mixed
Tags
since
4.0.0
Return values
mixed

export()

public static export(AnalyticsOptions|null $options[, string $scopeName = null ][, string $bucketName = null ]) : array<string|int, mixed>
Parameters
$options : AnalyticsOptions|null
$scopeName : string = null
$bucketName : string = null
Return values
array<string|int, mixed>

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

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
since
4.0.0
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

        

Search results