Cloud Bigtable V2 Client - Class SessionClientConfiguration (2.24.0)

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 \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ session_load float

What share of requests should operate on a session, [0, 1]. The rest should operate on the old-style API.

↳ load_balancing_options LoadBalancingOptions
↳ channel_configuration SessionClientConfiguration\ChannelPoolConfiguration

Configuration for the channel pool.

↳ session_pool_configuration SessionClientConfiguration\SessionPoolConfiguration

Configuration for the session pools.

getSessionLoad

What share of requests should operate on a session, [0, 1]. The rest should operate on the old-style API.

Returns
Type Description
float

setSessionLoad

What share of requests should operate on a session, [0, 1]. The rest should operate on the old-style API.

Parameter
Name Description
var float
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