Reference documentation and code samples for the Cloud Bigtable V2 Client class ClientConfiguration.
Configuration for the Session API. Internal usage only.
Generated from protobuf message google.bigtable.v2.ClientConfiguration
Namespace
Google \ Cloud \ Bigtable \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session_configuration |
SessionClientConfiguration
The configuration for Bigtable Sessions. |
↳ stop_polling |
bool
If the client should cease to check for new configurations, e.g. a backstop to prevent excessive GetClientConfiguration RPCs. |
↳ polling_interval |
Google\Protobuf\Duration
Deprecated, prerfer polling_configuration. A duration describing the time between GetClientConfiguration RPCs. Only strictly positive values are permissible. |
↳ polling_configuration |
ClientConfiguration\PollingConfiguration
If the client should continue to check for new configurations. |
↳ telemetry_configuration |
TelemetryConfiguration
Configuration for telemetry. |
getSessionConfiguration
The configuration for Bigtable Sessions.
| Returns | |
|---|---|
| Type | Description |
SessionClientConfiguration|null |
|
hasSessionConfiguration
clearSessionConfiguration
setSessionConfiguration
The configuration for Bigtable Sessions.
| Parameter | |
|---|---|
| Name | Description |
var |
SessionClientConfiguration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStopPolling
If the client should cease to check for new configurations, e.g. a backstop to prevent excessive GetClientConfiguration RPCs.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasStopPolling
setStopPolling
If the client should cease to check for new configurations, e.g. a backstop to prevent excessive GetClientConfiguration RPCs.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPollingInterval
Deprecated, prerfer polling_configuration.
A duration describing the time between GetClientConfiguration RPCs. Only strictly positive values are permissible.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasPollingInterval
setPollingInterval
Deprecated, prerfer polling_configuration.
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 |
|
getPollingConfiguration
If the client should continue to check for new configurations.
| Returns | |
|---|---|
| Type | Description |
ClientConfiguration\PollingConfiguration|null |
|
hasPollingConfiguration
setPollingConfiguration
If the client should continue to check for new configurations.
| Parameter | |
|---|---|
| Name | Description |
var |
ClientConfiguration\PollingConfiguration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTelemetryConfiguration
Configuration for telemetry.
| Returns | |
|---|---|
| Type | Description |
TelemetryConfiguration|null |
|
hasTelemetryConfiguration
clearTelemetryConfiguration
setTelemetryConfiguration
Configuration for telemetry.
| Parameter | |
|---|---|
| Name | Description |
var |
TelemetryConfiguration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPolling
| Returns | |
|---|---|
| Type | Description |
string |
|