SessionClientConfiguration.SessionPoolConfigurationOrBuilder (proto-google-cloud-bigtable-v2 2.78.1 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SessionClientConfiguration.SessionPoolConfiguration, SessionClientConfiguration.SessionPoolConfiguration.Builder

Enclosing class:

SessionClientConfiguration
```
public static interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`getConsecutiveSessionFailureThreshold()` A threshold for cancelling all pending vRPCs based on how many consecutive session establishment errors have been observed.
`float`	`getHeadroom()` Fraction of idle sessions to keep in order to manage an increase in requests-in-flight.
`LoadBalancingOptions`	`getLoadBalancingOptions()` How to balance vRPC load over connections to AFEs.
`LoadBalancingOptionsOrBuilder`	`getLoadBalancingOptionsOrBuilder()` How to balance vRPC load over connections to AFEs.
`int`	`getMaxSessionCount()` The maximum number of sessions for a given scope.
`int`	`getMinSessionCount()` The minimum number of sessions for a given scope.
`int`	`getNewSessionCreationBudget()` How many concurrent session establishments are allowed.
`com.google.protobuf.Duration`	`getNewSessionCreationPenalty()` How long to penalize the creation budget for a failed session creation attempt.
`com.google.protobuf.DurationOrBuilder`	`getNewSessionCreationPenaltyOrBuilder()` How long to penalize the creation budget for a failed session creation attempt.
`int`	`getNewSessionQueueLength()` Number of vRPCs that can be queued per starting session.
`boolean`	`hasLoadBalancingOptions()` How to balance vRPC load over connections to AFEs.
`boolean`	`hasNewSessionCreationPenalty()` How long to penalize the creation budget for a failed session creation attempt.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

getHeadroom

float getHeadroom()

 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.

float headroom = 1;

Returns:: The headroom.

getMinSessionCount

int getMinSessionCount()

 The minimum number of sessions for a given scope.

int32 min_session_count = 2;

Returns:: The minSessionCount.

getMaxSessionCount

int getMaxSessionCount()

 The maximum number of sessions for a given scope.

int32 max_session_count = 3;

Returns:: The maxSessionCount.

getNewSessionQueueLength

int getNewSessionQueueLength()

 Number of vRPCs that can be queued per starting session.

int32 new_session_queue_length = 4;

Returns:: The newSessionQueueLength.

getNewSessionCreationBudget

int getNewSessionCreationBudget()

 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.

int32 new_session_creation_budget = 5;

Returns:: The newSessionCreationBudget.

hasNewSessionCreationPenalty
```
boolean hasNewSessionCreationPenalty()
```
```
 How long to penalize the creation budget for a failed session creation
 attempt.
 
```
.google.protobuf.Duration new_session_creation_penalty = 6;
Returns:

Whether the newSessionCreationPenalty field is set.

getNewSessionCreationPenalty

com.google.protobuf.Duration getNewSessionCreationPenalty()

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

.google.protobuf.Duration new_session_creation_penalty = 6;

Returns:: The newSessionCreationPenalty.

getNewSessionCreationPenaltyOrBuilder

com.google.protobuf.DurationOrBuilder getNewSessionCreationPenaltyOrBuilder()

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

.google.protobuf.Duration new_session_creation_penalty = 6;

getConsecutiveSessionFailureThreshold

int getConsecutiveSessionFailureThreshold()

 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).

int32 consecutive_session_failure_threshold = 8;

Returns:: The consecutiveSessionFailureThreshold.

hasLoadBalancingOptions
```
boolean hasLoadBalancingOptions()
```
```
 How to balance vRPC load over connections to AFEs.
 Set only if session_load > 0.
 
```
.google.bigtable.v2.LoadBalancingOptions load_balancing_options = 9;
Returns:

Whether the loadBalancingOptions field is set.

getLoadBalancingOptions

LoadBalancingOptions getLoadBalancingOptions()

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

.google.bigtable.v2.LoadBalancingOptions load_balancing_options = 9;

Returns:: The loadBalancingOptions.

getLoadBalancingOptionsOrBuilder

LoadBalancingOptionsOrBuilder getLoadBalancingOptionsOrBuilder()

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