Class QuotaLimit

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
Implements
Inherited Members
Namespace: Google.Apis.ServiceConsumerManagement.v1beta1.Data
Assembly: Google.Apis.ServiceConsumerManagement.v1beta1.dll
Syntax
public class QuotaLimit : IDirectResponseSchema

Properties

DefaultLimit

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.

Declaration
[JsonProperty("defaultLimit")]
public virtual long? DefaultLimit { get; set; }
Property Value
Type Description
long?

Description

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).

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DisplayName

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.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

Duration

Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.

Declaration
[JsonProperty("duration")]
public virtual string Duration { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FreeTier

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.

Declaration
[JsonProperty("freeTier")]
public virtual long? FreeTier { get; set; }
Property Value
Type Description
long?

MaxLimit

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.

Declaration
[JsonProperty("maxLimit")]
public virtual long? MaxLimit { get; set; }
Property Value
Type Description
long?

Metric

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.

Declaration
[JsonProperty("metric")]
public virtual string Metric { get; set; }
Property Value
Type Description
string

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Unit

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.

Declaration
[JsonProperty("unit")]
public virtual string Unit { get; set; }
Property Value
Type Description
string

Values

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.

Declaration
[JsonProperty("values")]
public virtual IDictionary<string, long?> Values { get; set; }
Property Value
Type Description
IDictionary<string, long?>

Implements