RateLimitEvent

pydantic model gafaelfawr.events.RateLimitEvent

Authentication request rejected by API rate limits.

Parameters:

data (Any)

Show JSON schema

{
   "title": "RateLimitEvent",
   "description": "Authentication request rejected by API rate limits.",
   "type": "object",
   "properties": {
      "username": {
         "description": "Username of authenticated user",
         "title": "Username",
         "type": "string"
      },
      "is_bot": {
         "description": "Whether this user is a bot user",
         "title": "Whether user is a bot",
         "type": "boolean"
      },
      "service": {
         "description": "Service to which the user was authenticated",
         "title": "Service",
         "type": "string"
      },
      "quota": {
         "description": "API quota amount that was exceeded",
         "title": "Quota",
         "type": "integer"
      }
   },
   "required": [
      "username",
      "is_bot",
      "service",
      "quota"
   ]
}

Fields:

• is_bot (bool)

• quota (int)

• service (str)

• username (str)

field is_bot: bool [Required]

Whether this user is a bot user

field quota: int [Required]

API quota amount that was exceeded

field service: str [Required]

Service to which the user was authenticated

field username: str [Required]

Username of authenticated user

asdict()

Returns this model in dictionary form. This method differs from pydantic’s dict by converting all values to their Avro representation. It also doesn’t provide the exclude, include, by_alias, etc. parameters that dict provides.

Return type:

Dict[str, Any]

classmethod fake(**data)

Creates a fake instance of the model.

Attributes:

data: Dict[str, Any] represent the user values to use in the instance

Parameters:

data (Any)

Return type:

AvroBaseModel

classmethod json_schema(*args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

serialize(serialization_type='avro')

Overrides the base AvroModel’s serialize method to inject this class’s standardization factory method

Parameters:

serialization_type (Literal['avro', 'avro-json'], default: 'avro')

Return type:

bytes

to_dict()

Return type:

Dict[str, Any]

validate_avro()

Validate that instance matches the avro schema

Return type:

bool

classmethod validate_structure()

Do runtime validation of fields.

Make sure all of the fields are compatible with the backing datastore (InfluxDB at the moment).

Return type:

None