Google Bigtable v2 API - Class SessionClientConfiguration.Types.SessionPoolConfiguration (3.27.0)

public sealed class SessionClientConfiguration.Types.SessionPoolConfiguration : IMessage<SessionClientConfiguration.Types.SessionPoolConfiguration>, IEquatable<SessionClientConfiguration.Types.SessionPoolConfiguration>, IDeepCloneable<SessionClientConfiguration.Types.SessionPoolConfiguration>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API class SessionClientConfiguration.Types.SessionPoolConfiguration.

Configuration for the session pools. Session pools are tied to a scope like a table, an app profile, and a permission.

Inheritance

object > SessionClientConfiguration.Types.SessionPoolConfiguration

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

SessionPoolConfiguration()

public SessionPoolConfiguration()

SessionPoolConfiguration(SessionPoolConfiguration)

public SessionPoolConfiguration(SessionClientConfiguration.Types.SessionPoolConfiguration other)
Parameter
Name Description
other SessionClientConfigurationTypesSessionPoolConfiguration

Properties

ConsecutiveSessionFailureThreshold

public int ConsecutiveSessionFailureThreshold { get; set; }

A threshold for cancelling all pending vRPCs based on how many consecutive session establishment errors have been observed. The client will eagerly cancel queued vRPCs after this threshold is met to avoid them waiting their entire deadlines before terminating (while waiting for any session to establish to actually send the vRPC).

Property Value
Type Description
int

Headroom

public float Headroom { get; set; }

Fraction of idle sessions to keep in order to manage an increase in requests-in-flight. For example, a headroom of 0.5 will keep enough sessions to deal with a 50% increase in QPS.

Property Value
Type Description
float

LoadBalancingOptions

public LoadBalancingOptions LoadBalancingOptions { get; set; }

How to balance vRPC load over connections to AFEs. Set only if session_load > 0.

Property Value
Type Description
LoadBalancingOptions

MaxSessionCount

public int MaxSessionCount { get; set; }

The maximum number of sessions for a given scope.

Property Value
Type Description
int

MinSessionCount

public int MinSessionCount { get; set; }

The minimum number of sessions for a given scope.

Property Value
Type Description
int

NewSessionCreationBudget

public int NewSessionCreationBudget { get; set; }

How many concurrent session establishments are allowed. The client will hold onto a count against this budget whenever it is establishing a new session, and release that count once the session is successfully established or failed to establish.

Property Value
Type Description
int

NewSessionCreationPenalty

public Duration NewSessionCreationPenalty { get; set; }

How long to penalize the creation budget for a failed session creation attempt.

Property Value
Type Description
Duration

NewSessionQueueLength

public int NewSessionQueueLength { get; set; }

Number of vRPCs that can be queued per starting session.

Property Value
Type Description
int