public sealed class QuotaLimit : IMessage<QuotaLimit>, IEquatable<QuotaLimit>, IDeepCloneable<QuotaLimit>, IBufferMessage, IMessage
QuotaLimit defines a specific limit that applies over a specified duration
for a limit type. There can be at most one limit for a duration and limit
type combination defined within a QuotaGroup.
Inheritance
object >
QuotaLimit
Namespace
Google.Api
Assembly
Google.Api.CommonProtos.dll
Constructors
QuotaLimit()
QuotaLimit(QuotaLimit)
public QuotaLimit(QuotaLimit other)
Fields
DefaultLimitFieldNumber
public const int DefaultLimitFieldNumber = 3
Field number for the "default_limit" field.
| Field Value |
| Type |
Description |
int |
|
DescriptionFieldNumber
public const int DescriptionFieldNumber = 2
Field number for the "description" field.
| Field Value |
| Type |
Description |
int |
|
DisplayNameFieldNumber
public const int DisplayNameFieldNumber = 12
Field number for the "display_name" field.
| Field Value |
| Type |
Description |
int |
|
DurationFieldNumber
public const int DurationFieldNumber = 5
Field number for the "duration" field.
| Field Value |
| Type |
Description |
int |
|
FreeTierFieldNumber
public const int FreeTierFieldNumber = 7
Field number for the "free_tier" field.
| Field Value |
| Type |
Description |
int |
|
MaxLimitFieldNumber
public const int MaxLimitFieldNumber = 4
Field number for the "max_limit" field.
| Field Value |
| Type |
Description |
int |
|
MetricFieldNumber
public const int MetricFieldNumber = 8
Field number for the "metric" field.
| Field Value |
| Type |
Description |
int |
|
NameFieldNumber
public const int NameFieldNumber = 6
Field number for the "name" field.
| Field Value |
| Type |
Description |
int |
|
UnitFieldNumber
public const int UnitFieldNumber = 9
Field number for the "unit" field.
| Field Value |
| Type |
Description |
int |
|
ValuesFieldNumber
public const int ValuesFieldNumber = 10
Field number for the "values" field.
| Field Value |
| Type |
Description |
int |
|
Properties
DefaultLimit
public long DefaultLimit { get; set; }
Default number of tokens that can be consumed during the specified
duration. This is the number of tokens assigned when a client
application developer activates the service for his/her project.
Specifying a value of 0 will block all requests. This can be used if you
are provisioning quota to selected consumers and blocking others.
Similarly, a value of -1 will indicate an unlimited quota. No other
negative values are allowed.
Used by group-based quotas only.
| Property Value |
| Type |
Description |
long |
|
Description
public string Description { get; set; }
Optional. User-visible, extended description for this quota limit.
Should be used only when more context is needed to understand this limit
than provided by the limit's display name (see: display_name).
| Property Value |
| Type |
Description |
string |
|
Descriptor
public static MessageDescriptor Descriptor { get; }
DisplayName
public string DisplayName { get; set; }
User-visible display name for this limit.
Optional. If not set, the UI will provide a default display name based on
the quota configuration. This field can be used to override the default
display name generated from the configuration.
| Property Value |
| Type |
Description |
string |
|
Duration
public string Duration { get; set; }
Duration of this limit in textual notation. Must be "100s" or "1d".
Used by group-based quotas only.
| Property Value |
| Type |
Description |
string |
|
FreeTier
public long FreeTier { get; set; }
Free tier value displayed in the Developers Console for this limit.
The free tier is the number of tokens that will be subtracted from the
billed amount when billing is enabled.
This field can only be set on a limit with duration "1d", in a billable
group; it is invalid on any other limit. If this field is not set, it
defaults to 0, indicating that there is no free tier for this service.
Used by group-based quotas only.
| Property Value |
| Type |
Description |
long |
|
MaxLimit
public long MaxLimit { get; set; }
Maximum number of tokens that can be consumed during the specified
duration. Client application developers can override the default limit up
to this maximum. If specified, this value cannot be set to a value less
than the default limit. If not specified, it is set to the default limit.
To allow clients to apply overrides with no upper bound, set this to -1,
indicating unlimited maximum quota.
Used by group-based quotas only.
| Property Value |
| Type |
Description |
long |
|
Metric
public string Metric { get; set; }
The name of the metric this quota limit applies to. The quota limits with
the same metric will be checked together during runtime. The metric must be
defined within the service config.
| Property Value |
| Type |
Description |
string |
|
Name
public string Name { get; set; }
Name of the quota limit.
The name must be provided, and it must be unique within the service. The
name can only include alphanumeric characters as well as '-'.
The maximum length of the limit name is 64 characters.
| Property Value |
| Type |
Description |
string |
|
Parser
public static MessageParser<QuotaLimit> Parser { get; }
Unit
public string Unit { get; set; }
Specify the unit of the quota limit. It uses the same syntax as
[Metric.unit][]. The supported unit kinds are determined by the quota
backend system.
Here are some examples:
- "1/min/{project}" for quota per minute per project.
Note: the order of unit components is insignificant.
The "1" at the beginning is required to follow the metric unit syntax.
| Property Value |
| Type |
Description |
string |
|
Values
public MapField<string, long> Values { get; }
Tiered limit values. You must specify this as a key:value pair, with an
integer value that is the maximum number of requests allowed for the
specified unit. Currently only STANDARD is supported.
Methods
CalculateSize()
public int CalculateSize()
| Returns |
| Type |
Description |
int |
|
Clone()
public QuotaLimit Clone()
Equals(QuotaLimit)
public bool Equals(QuotaLimit other)
| Returns |
| Type |
Description |
bool |
|
Equals(object)
public override bool Equals(object other)
| Parameter |
| Name |
Description |
other |
object
|
| Returns |
| Type |
Description |
bool |
|
Overrides
GetHashCode()
public override int GetHashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
MergeFrom(QuotaLimit)
public void MergeFrom(QuotaLimit other)
public void MergeFrom(CodedInputStream input)
ToString()
public override string ToString()
| Returns |
| Type |
Description |
string |
|
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
