Google Bigtable v2 API - Class RateLimitInfo (3.12.0)

public sealed class RateLimitInfo : IMessage<RateLimitInfo>, IEquatable<RateLimitInfo>, IDeepCloneable<RateLimitInfo>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API class RateLimitInfo.

Information about how client should adjust the load to Bigtable.

Inheritance

object > RateLimitInfo

Implements

IMessage RateLimitInfo, IEquatable RateLimitInfo, IDeepCloneable RateLimitInfo, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

RateLimitInfo()

public RateLimitInfo()

RateLimitInfo(RateLimitInfo)

public RateLimitInfo(RateLimitInfo other)

Parameter
Name	Description
`other`	`RateLimitInfo`

Properties

Factor

public double Factor { get; set; }

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.

Property Value
Type	Description
`double`

Period

public Duration Period { get; set; }

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.

Property Value
Type	Description
`Duration`