Reference documentation and code samples for the Cloud Bigtable V2 Client class RateLimitInfo.
Information about how client should adjust the load to Bigtable.
Generated from protobuf message google.bigtable.v2.RateLimitInfo
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ period |
Google\Protobuf\Duration
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. |
↳ factor |
float
If it has been at least one |
getPeriod
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasPeriod
clearPeriod
setPeriod
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFactor
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 | |
|---|---|
| Type | Description |
float | |
setFactor
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |