Reference documentation and code samples for the Cloud Bigtable V2 Client class ChannelPoolConfiguration.
Configuration for the channel pool.
Generated from protobuf message google.bigtable.v2.SessionClientConfiguration.ChannelPoolConfiguration
Namespace
Google \ Cloud \ Bigtable \ V2 \ SessionClientConfigurationMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ min_server_count |
int
The minimum number of distcint servers to connect to in the channel pool. The client will ensure that the channel pool will have at least this many distinct servers, but may have multiple channels connected to the same server (e.g. the client may have M channels on N machines, where M > N). |
↳ max_server_count |
int
The maximum number of distinct servers to connect to in the channel pool. The client will ensure that the channel pool will have at most this many distinct servers. |
↳ per_server_session_count |
int
Soft maximum for how many sessions are allowed per server. Normally, the client will ensure that it does not host more than this count of sessions per server, unless there are other limits encountered (e.g. the connected servers is already at max_servers). |
↳ direct_access_with_fallback |
ChannelPoolConfiguration\DirectAccessWithFallback
DirectAccess with a fallback to CloudPath. |
↳ direct_access_only |
ChannelPoolConfiguration\DirectAccessOnly
DirectAccess only. |
↳ cloud_path_only |
ChannelPoolConfiguration\CloudPathOnly
CloudPath only. |
getMinServerCount
The minimum number of distcint servers to connect to in the channel pool.
The client will ensure that the channel pool will have at least this many distinct servers, but may have multiple channels connected to the same server (e.g. the client may have M channels on N machines, where M > N).
| Returns | |
|---|---|
| Type | Description |
int |
|
setMinServerCount
The minimum number of distcint servers to connect to in the channel pool.
The client will ensure that the channel pool will have at least this many distinct servers, but may have multiple channels connected to the same server (e.g. the client may have M channels on N machines, where M > N).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxServerCount
The maximum number of distinct servers to connect to in the channel pool.
The client will ensure that the channel pool will have at most this many distinct servers.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxServerCount
The maximum number of distinct servers to connect to in the channel pool.
The client will ensure that the channel pool will have at most this many distinct servers.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPerServerSessionCount
Soft maximum for how many sessions are allowed per server. Normally, the client will ensure that it does not host more than this count of sessions per server, unless there are other limits encountered (e.g. the connected servers is already at max_servers).
| Returns | |
|---|---|
| Type | Description |
int |
|
setPerServerSessionCount
Soft maximum for how many sessions are allowed per server. Normally, the client will ensure that it does not host more than this count of sessions per server, unless there are other limits encountered (e.g. the connected servers is already at max_servers).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDirectAccessWithFallback
DirectAccess with a fallback to CloudPath.
| Returns | |
|---|---|
| Type | Description |
ChannelPoolConfiguration\DirectAccessWithFallback|null |
|
hasDirectAccessWithFallback
setDirectAccessWithFallback
DirectAccess with a fallback to CloudPath.
| Parameter | |
|---|---|
| Name | Description |
var |
ChannelPoolConfiguration\DirectAccessWithFallback
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDirectAccessOnly
DirectAccess only.
| Returns | |
|---|---|
| Type | Description |
ChannelPoolConfiguration\DirectAccessOnly|null |
|
hasDirectAccessOnly
setDirectAccessOnly
DirectAccess only.
| Parameter | |
|---|---|
| Name | Description |
var |
ChannelPoolConfiguration\DirectAccessOnly
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCloudPathOnly
CloudPath only.
| Returns | |
|---|---|
| Type | Description |
ChannelPoolConfiguration\CloudPathOnly|null |
|
hasCloudPathOnly
setCloudPathOnly
CloudPath only.
| Parameter | |
|---|---|
| Name | Description |
var |
ChannelPoolConfiguration\CloudPathOnly
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMode
| Returns | |
|---|---|
| Type | Description |
string |
|