Reference documentation and code samples for the Cloud Bigtable V2 Client class SessionClientConfiguration.
Configuration for the Session API. Internal usage only.
Generated from protobuf message google.bigtable.v2.SessionClientConfiguration
Namespace
Google \ Cloud \ Bigtable \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session_load |
float
Deprecated: Prefer session_diversion_configuration. If both are provided, the client should apply this session_load to Bigtable.ReadRow & Bigtable.MutateRow, then process the session_diversion_configuration, overwriting any behavior established by this value. What share of the following methods should operate on a session, [0, 1]: * * Bigtable.ReadRow * * Bigtable.MutateRow The rest should operate on the classic API, e.g. have session_load = 0. |
↳ session_diversion_configuration |
SessionDiversionConfiguration
How load should be divered to sessions. |
↳ load_balancing_options |
LoadBalancingOptions
|
↳ channel_configuration |
SessionClientConfiguration\ChannelPoolConfiguration
Configuration for the channel pool. |
↳ session_pool_configuration |
SessionClientConfiguration\SessionPoolConfiguration
Configuration for the session pools. |
getSessionLoad
Deprecated: Prefer session_diversion_configuration. If both are provided, the client should apply this session_load to Bigtable.ReadRow & Bigtable.MutateRow, then process the session_diversion_configuration, overwriting any behavior established by this value.
What share of the following methods should operate on a session, [0, 1]:
- Bigtable.ReadRow
- Bigtable.MutateRow The rest should operate on the classic API, e.g. have session_load = 0.
| Returns | |
|---|---|
| Type | Description |
float |
|
setSessionLoad
Deprecated: Prefer session_diversion_configuration. If both are provided, the client should apply this session_load to Bigtable.ReadRow & Bigtable.MutateRow, then process the session_diversion_configuration, overwriting any behavior established by this value.
What share of the following methods should operate on a session, [0, 1]:
- Bigtable.ReadRow
- Bigtable.MutateRow The rest should operate on the classic API, e.g. have session_load = 0.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSessionDiversionConfiguration
How load should be divered to sessions.
| Returns | |
|---|---|
| Type | Description |
SessionDiversionConfiguration|null |
|
hasSessionDiversionConfiguration
clearSessionDiversionConfiguration
setSessionDiversionConfiguration
How load should be divered to sessions.
| Parameter | |
|---|---|
| Name | Description |
var |
SessionDiversionConfiguration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoadBalancingOptions
Generated from protobuf field .google.bigtable.v2.LoadBalancingOptions load_balancing_options = 2 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
LoadBalancingOptions|null |
|
hasLoadBalancingOptions
clearLoadBalancingOptions
setLoadBalancingOptions
Generated from protobuf field .google.bigtable.v2.LoadBalancingOptions load_balancing_options = 2 [deprecated = true];
| Parameter | |
|---|---|
| Name | Description |
var |
LoadBalancingOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChannelConfiguration
Configuration for the channel pool.
| Returns | |
|---|---|
| Type | Description |
SessionClientConfiguration\ChannelPoolConfiguration|null |
|
hasChannelConfiguration
clearChannelConfiguration
setChannelConfiguration
Configuration for the channel pool.
| Parameter | |
|---|---|
| Name | Description |
var |
SessionClientConfiguration\ChannelPoolConfiguration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSessionPoolConfiguration
Configuration for the session pools.
| Returns | |
|---|---|
| Type | Description |
SessionClientConfiguration\SessionPoolConfiguration|null |
|
hasSessionPoolConfiguration
clearSessionPoolConfiguration
setSessionPoolConfiguration
Configuration for the session pools.
| Parameter | |
|---|---|
| Name | Description |
var |
SessionClientConfiguration\SessionPoolConfiguration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|