Reference documentation and code samples for the Cloud Bigtable V2 Client class PollingConfiguration.
Generated from protobuf message google.bigtable.v2.ClientConfiguration.PollingConfiguration
Namespace
Google \ Cloud \ Bigtable \ V2 \ ClientConfigurationMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ polling_interval |
Google\Protobuf\Duration
A duration describing the time between GetClientConfiguration RPCs. Only strictly positive values are permissible. |
↳ validity_duration |
Google\Protobuf\Duration
How long the client should consider the configuration it receives from GetClientConfiguration valid for. Once this duration has passed, the client should consider the configuration invalid and must either: - Get a new configuration from GetClientConfiguration - Or if it cannot, use a sane default configuration This duration will be at least as long as the polling interval. |
↳ max_rpc_retry_count |
int
Number of times the client should retry a failed GetClientConfiguration RPC per polling interval before giving up. |
getPollingInterval
A duration describing the time between GetClientConfiguration RPCs.
Only strictly positive values are permissible.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasPollingInterval
clearPollingInterval
setPollingInterval
A duration describing the time between GetClientConfiguration RPCs.
Only strictly positive values are permissible.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getValidityDuration
How long the client should consider the configuration it receives from GetClientConfiguration valid for. Once this duration has passed, the client should consider the configuration invalid and must either:
- Get a new configuration from GetClientConfiguration
- Or if it cannot, use a sane default configuration This duration will be at least as long as the polling interval.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasValidityDuration
clearValidityDuration
setValidityDuration
How long the client should consider the configuration it receives from GetClientConfiguration valid for. Once this duration has passed, the client should consider the configuration invalid and must either:
- Get a new configuration from GetClientConfiguration
- Or if it cannot, use a sane default configuration This duration will be at least as long as the polling interval.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxRpcRetryCount
Number of times the client should retry a failed GetClientConfiguration RPC per polling interval before giving up.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxRpcRetryCount
Number of times the client should retry a failed GetClientConfiguration RPC per polling interval before giving up.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|