Struct RateLimitingObservation 

pub struct RateLimitingObservation {
    pub scope: RateLimitingObservationScope,
    pub type_: RateLimitingObservationType,
    pub usage: RateLimitUsage,
}

The rate-limit usage a rateLimiting criterion compared, read without being consumed. The criterion is met when the projected usage stays within the limit and unmet when it exceeds the limit. Totals can change before a real call.

JSON schema

{
 "title": "RateLimitingObservation",
 "description": "The rate-limit usage a `rateLimiting` criterion compared, read without being consumed. The criterion is met when the projected usage stays within the limit and unmet when it exceeds the limit. Totals can change before a real call.",
 "examples": [
   {
     "scope": "project",
     "type": "rateLimiting",
     "usage": {
       "pendingCount": 0,
       "type": "count",
       "windowCount": 10
     }
   }
 ],
 "type": "object",
 "required": [
   "scope",
   "type",
   "usage"
 ],
 "properties": {
   "scope": {
     "description": "Whose operations the counter totals. `project` counts operations of every account in the project, not only the account in the request. `end_user` counts operations of the end user in the request.",
     "examples": [
       "project"
     ],
     "type": "string",
     "enum": [
       "project",
       "end_user"
     ],
     "x-go-type": "string"
   },
   "type": {
     "description": "The criterion type.",
     "examples": [
       "rateLimiting"
     ],
     "type": "string",
     "enum": [
       "rateLimiting"
     ],
     "x-go-type": "string"
   },
   "usage": {
     "$ref": "#/components/schemas/RateLimitUsage"
   }
 },
 "additionalProperties": false
}

Fields

scope: RateLimitingObservationScope

Whose operations the counter totals. project counts operations of every account in the project, not only the account in the request. end_user counts operations of the end user in the request.

type_: RateLimitingObservationType

The criterion type.

usage: RateLimitUsage

Implementations

impl RateLimitingObservation

pub fn builder() -> RateLimitingObservation

Trait Implementations

impl Clone for RateLimitingObservation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateLimitingObservation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RateLimitingObservation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&RateLimitingObservation> for RateLimitingObservation

fn from(value: &RateLimitingObservation) -> Self

Converts to this type from the input type.

impl From<RateLimitingObservation> for PolicyCriterionObservation

fn from(value: RateLimitingObservation) -> Self

Converts to this type from the input type.

impl From<RateLimitingObservation> for RateLimitingObservation

fn from(value: RateLimitingObservation) -> Self

Converts to this type from the input type.

impl Serialize for RateLimitingObservation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RateLimitingObservation> for RateLimitingObservation

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: RateLimitingObservation) -> Result<Self, ConversionError>

Performs the conversion.