Struct Quota 

#[non_exhaustive]
pub struct Quota {
    pub limits: Vec<QuotaLimit>,
    pub metric_rules: Vec<MetricRule>,
    /* private fields */
}

Quota configuration helps to achieve fairness and budgeting in service usage.

The metric based quota configuration works this way:

• The service configuration defines a set of metrics.
• For API calls, the quota.metric_rules maps methods to metrics with corresponding costs.
• The quota.limits defines limits on the metrics, which will be used for quota checks at runtime.

An example quota configuration in yaml format:

quota: limits:

 - name: apiWriteQpsPerProject
   metric: library.googleapis.com/write_calls
   unit: "1/min/{project}"  # rate limit for consumer projects
   values:
     STANDARD: 10000


 (The metric rules bind all methods to the read_calls metric,
  except for the UpdateBook and DeleteBook methods. These two methods
  are mapped to the write_calls metric, with the UpdateBook method
  consuming at twice rate as the DeleteBook method.)
 metric_rules:
 - selector: "*"
   metric_costs:
     library.googleapis.com/read_calls: 1
 - selector: google.example.library.v1.LibraryService.UpdateBook
   metric_costs:
     library.googleapis.com/write_calls: 2
 - selector: google.example.library.v1.LibraryService.DeleteBook
   metric_costs:
     library.googleapis.com/write_calls: 1

Corresponding Metric definition:

 metrics:
 - name: library.googleapis.com/read_calls
   display_name: Read requests
   metric_kind: DELTA
   value_type: INT64

 - name: library.googleapis.com/write_calls
   display_name: Write requests
   metric_kind: DELTA
   value_type: INT64

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

limits: Vec<QuotaLimit>

List of QuotaLimit definitions for the service.

metric_rules: Vec<MetricRule>

List of MetricRule definitions, each one mapping a selected method to one or more metrics.

Implementations

impl Quota

pub fn new() -> Self

pub fn set_limits<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<QuotaLimit>,

Sets the value of limits.

pub fn set_metric_rules<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<MetricRule>,

Sets the value of metric_rules.

Trait Implementations

impl Clone for Quota

fn clone(&self) -> Quota

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Quota

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

Formats the value using the given formatter.

impl Default for Quota

fn default() -> Quota

Returns the “default value” for a type.

impl Message for Quota

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Quota

fn eq(&self, other: &Quota) -> 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 Quota