Class: Google::Cloud::Bigtable::V2::RateLimitInfo

Inherits:

Object

Object
Google::Cloud::Bigtable::V2::RateLimitInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/bigtable/v2/bigtable.rb

Overview

Information about how client should adjust the load to Bigtable.

Instance Attribute Summary collapse

#factor ⇒ ::Float
If it has been at least one period since the last load adjustment, the client should multiply the current load by this value to get the new target load.
#period ⇒ ::Google::Protobuf::Duration
Time that clients should wait before adjusting the target rate again.

Instance Attribute Details

#factor ⇒ `::Float`

Returns If it has been at least one period since the last load adjustment, the client should multiply the current load by this value to get the new target load. For example, if the current load is 100 and factor is 0.8, the new target load should be 80. After adjusting, the client should ignore factor until another period has passed.

The client can measure its load using any unit that's comparable over time For example, QPS can be used as long as each request involves a similar amount of work.

Returns:

(::Float) —
If it has been at least one period since the last load adjustment, the client should multiply the current load by this value to get the new target load. For example, if the current load is 100 and factor is 0.8, the new target load should be 80. After adjusting, the client should ignore factor until another period has passed.

The client can measure its load using any unit that's comparable over time For example, QPS can be used as long as each request involves a similar amount of work.

# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 371

class RateLimitInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#period ⇒ `::Google::Protobuf::Duration`

Returns Time that clients should wait before adjusting the target rate again. If clients adjust rate too frequently, the impact of the previous adjustment may not have been taken into account and may over-throttle or under-throttle. If clients adjust rate too slowly, they will not be responsive to load changes on server side, and may over-throttle or under-throttle.