Struct QuotaLimit

pub struct QuotaLimit {
    pub name: String,
    pub description: String,
    pub default_limit: i64,
    pub max_limit: i64,
    pub free_tier: i64,
    pub duration: String,
    pub metric: String,
    pub unit: String,
    pub values: HashMap<String, i64>,
    pub display_name: String,
}

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.

Fields

name: String

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.

description: String

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

default_limit: i64

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.

max_limit: i64

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.

free_tier: i64

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.

duration: String

Duration of this limit in textual notation. Must be “100s” or “1d”.

Used by group-based quotas only.

metric: String

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.

unit: String

Specify the unit of the quota limit. It uses the same syntax as [MetricDescriptor.unit][google.api.MetricDescriptor.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.

values: HashMap<String, i64>

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.

display_name: String

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.

Trait Implementations

impl Clone for QuotaLimit

fn clone(&self) -> QuotaLimit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QuotaLimit

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for QuotaLimit

fn default() -> QuotaLimit

Returns the “default value” for a type.

impl Message for QuotaLimit

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for QuotaLimit

fn eq(&self, other: &QuotaLimit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QuotaLimit