Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::SessionClientConfiguration::SessionPoolConfiguration.
Configuration for the session pools. Session pools are tied to a scope like a table, an app profile, and a permission.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#consecutive_session_failure_threshold
def consecutive_session_failure_threshold() -> ::Integer
Returns
- (::Integer) — 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).
#consecutive_session_failure_threshold=
def consecutive_session_failure_threshold=(value) -> ::Integer
Parameter
- value (::Integer) — 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).
Returns
- (::Integer) — 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).
#headroom
def headroom() -> ::Float
Returns
- (::Float) — 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.
#headroom=
def headroom=(value) -> ::Float
Parameter
- value (::Float) — 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.
Returns
- (::Float) — 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.
#load_balancing_options
def load_balancing_options() -> ::Google::Cloud::Bigtable::V2::LoadBalancingOptions
Returns
-
(::Google::Cloud::Bigtable::V2::LoadBalancingOptions) — How to balance vRPC load over connections to AFEs.
Set only if session_load or session_diversion_configuration indicates that there will be some session traffic.
#load_balancing_options=
def load_balancing_options=(value) -> ::Google::Cloud::Bigtable::V2::LoadBalancingOptions
Parameter
-
value (::Google::Cloud::Bigtable::V2::LoadBalancingOptions) — How to balance vRPC load over connections to AFEs.
Set only if session_load or session_diversion_configuration indicates that there will be some session traffic.
Returns
-
(::Google::Cloud::Bigtable::V2::LoadBalancingOptions) — How to balance vRPC load over connections to AFEs.
Set only if session_load or session_diversion_configuration indicates that there will be some session traffic.
#max_session_count
def max_session_count() -> ::Integer
Returns
- (::Integer) — The maximum number of sessions for a given scope.
#max_session_count=
def max_session_count=(value) -> ::Integer
Parameter
- value (::Integer) — The maximum number of sessions for a given scope.
Returns
- (::Integer) — The maximum number of sessions for a given scope.
#min_session_count
def min_session_count() -> ::Integer
Returns
- (::Integer) — The minimum number of sessions for a given scope.
#min_session_count=
def min_session_count=(value) -> ::Integer
Parameter
- value (::Integer) — The minimum number of sessions for a given scope.
Returns
- (::Integer) — The minimum number of sessions for a given scope.
#new_session_creation_budget
def new_session_creation_budget() -> ::Integer
Returns
- (::Integer) — 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.
#new_session_creation_budget=
def new_session_creation_budget=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
Returns
- (::Integer) — 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.
#new_session_creation_penalty
def new_session_creation_penalty() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — How long to penalize the creation budget for a failed session creation attempt.
#new_session_creation_penalty=
def new_session_creation_penalty=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — How long to penalize the creation budget for a failed session creation attempt.
Returns
- (::Google::Protobuf::Duration) — How long to penalize the creation budget for a failed session creation attempt.
#new_session_queue_length
def new_session_queue_length() -> ::Integer
Returns
- (::Integer) — Number of vRPCs that can be queued per starting session.
#new_session_queue_length=
def new_session_queue_length=(value) -> ::Integer
Parameter
- value (::Integer) — Number of vRPCs that can be queued per starting session.
Returns
- (::Integer) — Number of vRPCs that can be queued per starting session.
#soft_session_close_budget
def soft_session_close_budget() -> ::Integer
Returns
- (::Integer) — How many concurrent session closures are allowed. The client will hold onto a count against this budget whenever it is closing a session, and release that count once the session is successfully established or failed to establish.
#soft_session_close_budget=
def soft_session_close_budget=(value) -> ::Integer
Parameter
- value (::Integer) — How many concurrent session closures are allowed. The client will hold onto a count against this budget whenever it is closing a session, and release that count once the session is successfully established or failed to establish.
Returns
- (::Integer) — How many concurrent session closures are allowed. The client will hold onto a count against this budget whenever it is closing a session, and release that count once the session is successfully established or failed to establish.