com.google.bigtable.v2

Class SessionClientConfiguration.SessionPoolConfiguration

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.bigtable.v2.SessionClientConfiguration.SessionPoolConfiguration

All Implemented Interfaces:

SessionClientConfiguration.SessionPoolConfigurationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SessionClientConfiguration

public static final class SessionClientConfiguration.SessionPoolConfiguration
extends com.google.protobuf.GeneratedMessage
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionClientConfiguration.SessionPoolConfiguration.Builder Configuration for the session pools.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSECUTIVE_SESSION_FAILURE_THRESHOLD_FIELD_NUMBER
static int	HEADROOM_FIELD_NUMBER
static int	LOAD_BALANCING_OPTIONS_FIELD_NUMBER
static int	MAX_SESSION_COUNT_FIELD_NUMBER
static int	MIN_SESSION_COUNT_FIELD_NUMBER
static int	NEW_SESSION_CREATION_BUDGET_FIELD_NUMBER
static int	NEW_SESSION_CREATION_PENALTY_FIELD_NUMBER
static int	NEW_SESSION_QUEUE_LENGTH_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getConsecutiveSessionFailureThreshold() A threshold for cancelling all pending vRPCs based on how many consecutive session establishment errors have been observed.
static SessionClientConfiguration.SessionPoolConfiguration	getDefaultInstance()
SessionClientConfiguration.SessionPoolConfiguration	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<SessionClientConfiguration.SessionPoolConfiguration>	getParserForType()
int	getSerializedSize()
int	hashCode()
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()
static SessionClientConfiguration.SessionPoolConfiguration.Builder	newBuilder()
static SessionClientConfiguration.SessionPoolConfiguration.Builder	newBuilder(SessionClientConfiguration.SessionPoolConfiguration prototype)
SessionClientConfiguration.SessionPoolConfiguration.Builder	newBuilderForType()
protected SessionClientConfiguration.SessionPoolConfiguration.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SessionClientConfiguration.SessionPoolConfiguration	parseDelimitedFrom(InputStream input)
static SessionClientConfiguration.SessionPoolConfiguration	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(byte[] data)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(ByteBuffer data)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(com.google.protobuf.ByteString data)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(com.google.protobuf.CodedInputStream input)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(InputStream input)
static SessionClientConfiguration.SessionPoolConfiguration	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SessionClientConfiguration.SessionPoolConfiguration>	parser()
SessionClientConfiguration.SessionPoolConfiguration.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

HEADROOM_FIELD_NUMBER

public static final int HEADROOM_FIELD_NUMBER

See Also:

Constant Field Values

MIN_SESSION_COUNT_FIELD_NUMBER

public static final int MIN_SESSION_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MAX_SESSION_COUNT_FIELD_NUMBER

public static final int MAX_SESSION_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

NEW_SESSION_QUEUE_LENGTH_FIELD_NUMBER

public static final int NEW_SESSION_QUEUE_LENGTH_FIELD_NUMBER

See Also:

Constant Field Values

NEW_SESSION_CREATION_BUDGET_FIELD_NUMBER

public static final int NEW_SESSION_CREATION_BUDGET_FIELD_NUMBER

See Also:

Constant Field Values

NEW_SESSION_CREATION_PENALTY_FIELD_NUMBER

public static final int NEW_SESSION_CREATION_PENALTY_FIELD_NUMBER

See Also:

Constant Field Values

CONSECUTIVE_SESSION_FAILURE_THRESHOLD_FIELD_NUMBER

public static final int CONSECUTIVE_SESSION_FAILURE_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

LOAD_BALANCING_OPTIONS_FIELD_NUMBER

public static final int LOAD_BALANCING_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

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

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.

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.

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.

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.

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.

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.

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.

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.

getLoadBalancingOptionsOrBuilder

public LoadBalancingOptionsOrBuilder getLoadBalancingOptionsOrBuilder()

 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:

getLoadBalancingOptionsOrBuilder in interface SessionClientConfiguration.SessionPoolConfigurationOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(ByteBuffer data)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(ByteBuffer data,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(com.google.protobuf.ByteString data)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(com.google.protobuf.ByteString data,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(byte[] data)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(byte[] data,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(InputStream input)
                                                                     throws IOException

Throws:

IOException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(InputStream input,
                                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseDelimitedFrom(InputStream input)
                                                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseDelimitedFrom(InputStream input,
                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                              throws IOException

Throws:

IOException

parseFrom

public static SessionClientConfiguration.SessionPoolConfiguration parseFrom(com.google.protobuf.CodedInputStream input)
                                                                     throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public SessionClientConfiguration.SessionPoolConfiguration.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SessionClientConfiguration.SessionPoolConfiguration.Builder newBuilder()

newBuilder

public static SessionClientConfiguration.SessionPoolConfiguration.Builder newBuilder(SessionClientConfiguration.SessionPoolConfiguration prototype)

toBuilder

public SessionClientConfiguration.SessionPoolConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SessionClientConfiguration.SessionPoolConfiguration.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static SessionClientConfiguration.SessionPoolConfiguration getDefaultInstance()

parser

public static com.google.protobuf.Parser<SessionClientConfiguration.SessionPoolConfiguration> parser()

getParserForType

public com.google.protobuf.Parser<SessionClientConfiguration.SessionPoolConfiguration> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public SessionClientConfiguration.SessionPoolConfiguration getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder