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

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>
    - - com.google.bigtable.v2.SessionClientConfiguration.SessionPoolConfiguration.Builder

All Implemented Interfaces:

SessionClientConfiguration.SessionPoolConfigurationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SessionClientConfiguration.SessionPoolConfiguration
```
public static final class SessionClientConfiguration.SessionPoolConfiguration.Builder
extends com.google.protobuf.GeneratedMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>
implements SessionClientConfiguration.SessionPoolConfigurationOrBuilder
```
```
 Configuration for the session pools. Session pools are tied to a scope
 like a table, an app profile, and a permission.
 
```
Protobuf type google.bigtable.v2.SessionClientConfiguration.SessionPoolConfiguration

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SessionClientConfiguration.SessionPoolConfiguration`	`build()`
`SessionClientConfiguration.SessionPoolConfiguration`	`buildPartial()`
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clear()`
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearConsecutiveSessionFailureThreshold()` A threshold for cancelling all pending vRPCs based on how many consecutive session establishment errors have been observed.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearHeadroom()` Fraction of idle sessions to keep in order to manage an increase in requests-in-flight.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearLoadBalancingOptions()` How to balance vRPC load over connections to AFEs.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearMaxSessionCount()` The maximum number of sessions for a given scope.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearMinSessionCount()` The minimum number of sessions for a given scope.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearNewSessionCreationBudget()` How many concurrent session establishments are allowed.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearNewSessionCreationPenalty()` How long to penalize the creation budget for a failed session creation attempt.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`clearNewSessionQueueLength()` Number of vRPCs that can be queued per starting session.
`int`	`getConsecutiveSessionFailureThreshold()` A threshold for cancelling all pending vRPCs based on how many consecutive session establishment errors have been observed.
`SessionClientConfiguration.SessionPoolConfiguration`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`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.
`LoadBalancingOptions.Builder`	`getLoadBalancingOptionsBuilder()` 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.Duration.Builder`	`getNewSessionCreationPenaltyBuilder()` 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.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`mergeFrom(SessionClientConfiguration.SessionPoolConfiguration other)`
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`mergeLoadBalancingOptions(LoadBalancingOptions value)` How to balance vRPC load over connections to AFEs.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`mergeNewSessionCreationPenalty(com.google.protobuf.Duration value)` How long to penalize the creation budget for a failed session creation attempt.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setConsecutiveSessionFailureThreshold(int value)` A threshold for cancelling all pending vRPCs based on how many consecutive session establishment errors have been observed.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setHeadroom(float value)` Fraction of idle sessions to keep in order to manage an increase in requests-in-flight.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setLoadBalancingOptions(LoadBalancingOptions.Builder builderForValue)` How to balance vRPC load over connections to AFEs.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setLoadBalancingOptions(LoadBalancingOptions value)` How to balance vRPC load over connections to AFEs.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setMaxSessionCount(int value)` The maximum number of sessions for a given scope.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setMinSessionCount(int value)` The minimum number of sessions for a given scope.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setNewSessionCreationBudget(int value)` How many concurrent session establishments are allowed.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setNewSessionCreationPenalty(com.google.protobuf.Duration.Builder builderForValue)` How long to penalize the creation budget for a failed session creation attempt.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setNewSessionCreationPenalty(com.google.protobuf.Duration value)` How long to penalize the creation budget for a failed session creation attempt.
`SessionClientConfiguration.SessionPoolConfiguration.Builder`	`setNewSessionQueueLength(int value)` Number of vRPCs that can be queued per starting session.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>

clear
```
public SessionClientConfiguration.SessionPoolConfiguration.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>

getDefaultInstanceForType
```
public SessionClientConfiguration.SessionPoolConfiguration getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public SessionClientConfiguration.SessionPoolConfiguration build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public SessionClientConfiguration.SessionPoolConfiguration buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom
```
public SessionClientConfiguration.SessionPoolConfiguration.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>

mergeFrom

public SessionClientConfiguration.SessionPoolConfiguration.Builder mergeFrom(SessionClientConfiguration.SessionPoolConfiguration other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>

mergeFrom

public SessionClientConfiguration.SessionPoolConfiguration.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Specified by:: mergeFrom in interface com.google.protobuf.Message.Builder
Specified by:: mergeFrom in interface com.google.protobuf.MessageLite.Builder
Overrides:: mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SessionClientConfiguration.SessionPoolConfiguration.Builder>
Throws:: IOException

getHeadroom

public 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;

Specified by:: getHeadroom in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder
Returns:: The headroom.

setHeadroom

public SessionClientConfiguration.SessionPoolConfiguration.Builder setHeadroom(float value)

 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;

Parameters:: value - The headroom to set.
Returns:: This builder for chaining.

clearHeadroom

public SessionClientConfiguration.SessionPoolConfiguration.Builder clearHeadroom()

 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:: This builder for chaining.

getMinSessionCount
```
public int getMinSessionCount()
```
```
 The minimum number of sessions for a given scope.
 
```
int32 min_session_count = 2;
Specified by:

getMinSessionCount in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

Returns:

The minSessionCount.

setMinSessionCount

public SessionClientConfiguration.SessionPoolConfiguration.Builder setMinSessionCount(int value)

 The minimum number of sessions for a given scope.

int32 min_session_count = 2;

Parameters:: value - The minSessionCount to set.
Returns:: This builder for chaining.

clearMinSessionCount

public SessionClientConfiguration.SessionPoolConfiguration.Builder clearMinSessionCount()

 The minimum number of sessions for a given scope.

int32 min_session_count = 2;

Returns:: This builder for chaining.

getMaxSessionCount
```
public int getMaxSessionCount()
```
```
 The maximum number of sessions for a given scope.
 
```
int32 max_session_count = 3;
Specified by:

getMaxSessionCount in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

Returns:

The maxSessionCount.

setMaxSessionCount

public SessionClientConfiguration.SessionPoolConfiguration.Builder setMaxSessionCount(int value)

 The maximum number of sessions for a given scope.

int32 max_session_count = 3;

Parameters:: value - The maxSessionCount to set.
Returns:: This builder for chaining.

clearMaxSessionCount

public SessionClientConfiguration.SessionPoolConfiguration.Builder clearMaxSessionCount()

 The maximum number of sessions for a given scope.

int32 max_session_count = 3;

Returns:: This builder for chaining.

getNewSessionQueueLength
```
public int getNewSessionQueueLength()
```
```
 Number of vRPCs that can be queued per starting session.
 
```
int32 new_session_queue_length = 4;
Specified by:

getNewSessionQueueLength in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

Returns:

The newSessionQueueLength.

setNewSessionQueueLength

public SessionClientConfiguration.SessionPoolConfiguration.Builder setNewSessionQueueLength(int value)

 Number of vRPCs that can be queued per starting session.

int32 new_session_queue_length = 4;

Parameters:: value - The newSessionQueueLength to set.
Returns:: This builder for chaining.

clearNewSessionQueueLength

public SessionClientConfiguration.SessionPoolConfiguration.Builder clearNewSessionQueueLength()

 Number of vRPCs that can be queued per starting session.

int32 new_session_queue_length = 4;

Returns:: This builder for chaining.

getNewSessionCreationBudget

public 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;

Specified by:: getNewSessionCreationBudget in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder
Returns:: The newSessionCreationBudget.

setNewSessionCreationBudget

public SessionClientConfiguration.SessionPoolConfiguration.Builder setNewSessionCreationBudget(int value)

 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;

Parameters:: value - The newSessionCreationBudget to set.
Returns:: This builder for chaining.

clearNewSessionCreationBudget

public SessionClientConfiguration.SessionPoolConfiguration.Builder clearNewSessionCreationBudget()

 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:: This builder for chaining.

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

hasNewSessionCreationPenalty in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

Returns:

Whether the newSessionCreationPenalty field is set.

getNewSessionCreationPenalty
```
public 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;
Specified by:

getNewSessionCreationPenalty in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

Returns:

The newSessionCreationPenalty.

setNewSessionCreationPenalty

public SessionClientConfiguration.SessionPoolConfiguration.Builder setNewSessionCreationPenalty(com.google.protobuf.Duration value)

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

.google.protobuf.Duration new_session_creation_penalty = 6;

setNewSessionCreationPenalty

public SessionClientConfiguration.SessionPoolConfiguration.Builder setNewSessionCreationPenalty(com.google.protobuf.Duration.Builder builderForValue)

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

.google.protobuf.Duration new_session_creation_penalty = 6;

mergeNewSessionCreationPenalty

public SessionClientConfiguration.SessionPoolConfiguration.Builder mergeNewSessionCreationPenalty(com.google.protobuf.Duration value)

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

.google.protobuf.Duration new_session_creation_penalty = 6;

clearNewSessionCreationPenalty

public SessionClientConfiguration.SessionPoolConfiguration.Builder clearNewSessionCreationPenalty()

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

.google.protobuf.Duration new_session_creation_penalty = 6;

getNewSessionCreationPenaltyBuilder

public com.google.protobuf.Duration.Builder getNewSessionCreationPenaltyBuilder()

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

.google.protobuf.Duration new_session_creation_penalty = 6;

getNewSessionCreationPenaltyOrBuilder
```
public 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;
Specified by:

getNewSessionCreationPenaltyOrBuilder in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

getConsecutiveSessionFailureThreshold

public 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;

Specified by:: getConsecutiveSessionFailureThreshold in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder
Returns:: The consecutiveSessionFailureThreshold.

setConsecutiveSessionFailureThreshold

public SessionClientConfiguration.SessionPoolConfiguration.Builder setConsecutiveSessionFailureThreshold(int value)

 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;

Parameters:: value - The consecutiveSessionFailureThreshold to set.
Returns:: This builder for chaining.

clearConsecutiveSessionFailureThreshold

public SessionClientConfiguration.SessionPoolConfiguration.Builder clearConsecutiveSessionFailureThreshold()

 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:: This builder for chaining.

hasLoadBalancingOptions
```
public 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;
Specified by:

hasLoadBalancingOptions in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

Returns:

Whether the loadBalancingOptions field is set.

getLoadBalancingOptions
```
public 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;
Specified by:

getLoadBalancingOptions in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

Returns:

The loadBalancingOptions.