GetAllReplicasOptions
in package
Table of Contents
- $readPreference : string
- $timeoutMilliseconds : int|null
- $transcoder : Transcoder
- __construct() : mixed
- build() : GetAllReplicasOptions
- Static helper to keep code more readable
- getTranscoder() : Transcoder
- Returns associated transcoder.
- readPreference() : GetAllReplicasOptions
- Choose how the replica nodes will be selected. By default, it has no preference and will select any available replica, but it is possible to prioritize or restrict to only nodes in local server group
- timeout() : GetAllReplicasOptions
- Sets the operation timeout in milliseconds.
- transcoder() : GetAllReplicasOptions
- Associate custom transcoder with the request.
Properties
$readPreference
private
string
$readPreference
$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() : GetAllReplicasOptions
Tags
Return values
GetAllReplicasOptions —getTranscoder()
Returns associated transcoder.
public
static getTranscoder(GetAllReplicasOptions|null $options) : Transcoder
Parameters
- $options : GetAllReplicasOptions|null
Tags
Return values
Transcoder —readPreference()
Choose how the replica nodes will be selected. By default, it has no preference and will select any available replica, but it is possible to prioritize or restrict to only nodes in local server group
public
readPreference(string $readPreference) : GetAllReplicasOptions
Parameters
- $readPreference : string
Tags
Return values
GetAllReplicasOptions —timeout()
Sets the operation timeout in milliseconds.
public
timeout(int $milliseconds) : GetAllReplicasOptions
Parameters
- $milliseconds : int
-
the operation timeout to apply
Tags
Return values
GetAllReplicasOptions —transcoder()
Associate custom transcoder with the request.
public
transcoder(Transcoder $transcoder) : GetAllReplicasOptions
Parameters
- $transcoder : Transcoder