GetReplicaOptions
in package
Options for Collection::getReplica().
Tags
Table of Contents
- $parentSpan : RequestSpan|null
- $timeoutMilliseconds : int|null
- $transcoder : Transcoder
- __construct() : mixed
- build() : GetReplicaOptions
- Static helper to keep code more readable
- getTranscoder() : Transcoder
- Returns associated transcoder.
- parentSpan() : GetReplicaOptions
- Sets the parent span.
- timeout() : GetReplicaOptions
- Sets the operation timeout in milliseconds.
- transcoder() : GetReplicaOptions
- Associate custom transcoder with the request.
Properties
$parentSpan
private
RequestSpan|null
$parentSpan
= null
$timeoutMilliseconds
private
int|null
$timeoutMilliseconds
= null
$transcoder
private
Transcoder
$transcoder
Methods
__construct()
public
__construct() : mixed
Return values
mixed —build()
Static helper to keep code more readable
public
static build() : GetReplicaOptions
Tags
Return values
GetReplicaOptions —getTranscoder()
Returns associated transcoder.
public
static getTranscoder(GetReplicaOptions|null $options) : Transcoder
Parameters
- $options : GetReplicaOptions|null
Tags
Return values
Transcoder —parentSpan()
Sets the parent span.
public
parentSpan(RequestSpan $parentSpan) : GetReplicaOptions
Parameters
- $parentSpan : RequestSpan
-
the parent span
Tags
Return values
GetReplicaOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : GetReplicaOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
GetReplicaOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : GetReplicaOptions
Parameters
- $transcoder : Transcoder