Struct QuotaOperation 

#[non_exhaustive]
pub struct QuotaOperation {
    pub operation_id: String,
    pub method_name: String,
    pub consumer_id: String,
    pub labels: HashMap<String, String>,
    pub quota_metrics: Vec<MetricValueSet>,
    pub quota_mode: QuotaMode,
    /* private fields */
}

Represents information regarding a quota operation.

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.

operation_id: String

Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID

method_name: String

Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration.

This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override.

Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf

consumer_id: String

Identity of the consumer for whom this quota operation is being performed.

This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>.

labels: HashMap<String, String>

Labels describing the operation.

quota_metrics: Vec<MetricValueSet>

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

quota_mode: QuotaMode

Quota mode for this operation.

Implementations

impl QuotaOperation

pub fn new() -> Self

pub fn set_operation_id<T: Into<String>>(self, v: T) -> Self

Sets the value of operation_id.

Example

let x = QuotaOperation::new().set_operation_id("example");

pub fn set_method_name<T: Into<String>>(self, v: T) -> Self

Sets the value of method_name.

Example

let x = QuotaOperation::new().set_method_name("example");

pub fn set_consumer_id<T: Into<String>>(self, v: T) -> Self

Sets the value of consumer_id.

Example

let x = QuotaOperation::new().set_consumer_id("example");

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = QuotaOperation::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

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

Sets the value of quota_metrics.

Example

use google_cloud_api_servicecontrol_v1::model::MetricValueSet;
let x = QuotaOperation::new()
    .set_quota_metrics([
        MetricValueSet::default()/* use setters */,
        MetricValueSet::default()/* use (different) setters */,
    ]);

pub fn set_quota_mode<T: Into<QuotaMode>>(self, v: T) -> Self

Sets the value of quota_mode.

Example

use google_cloud_api_servicecontrol_v1::model::quota_operation::QuotaMode;
let x0 = QuotaOperation::new().set_quota_mode(QuotaMode::Normal);
let x1 = QuotaOperation::new().set_quota_mode(QuotaMode::BestEffort);
let x2 = QuotaOperation::new().set_quota_mode(QuotaMode::CheckOnly);

Trait Implementations

impl Clone for QuotaOperation

fn clone(&self) -> QuotaOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuotaOperation

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

Formats the value using the given formatter.

impl Default for QuotaOperation

fn default() -> QuotaOperation

Returns the “default value” for a type.

impl Message for QuotaOperation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for QuotaOperation

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