get_gateway_rate_limit¶
Operation¶
get_gateway_rate_limit
¶
get_gateway_rate_limit(request: GetGatewayRateLimitInput | GetGatewayRateLimitInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayRateLimitInputDict]) -> GetGatewayRateLimitOutput
Retrieves information about a gateway rate limit.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetGatewayRateLimitInput | GetGatewayRateLimitInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetGatewayRateLimitInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetGatewayRateLimitOutput
|
An instance of |
get_gateway_rate_limit
async
¶
get_gateway_rate_limit(request: GetGatewayRateLimitInput | GetGatewayRateLimitInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayRateLimitInputDict]) -> GetGatewayRateLimitOutput
Retrieves information about a gateway rate limit.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetGatewayRateLimitInput | GetGatewayRateLimitInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[GetGatewayRateLimitInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetGatewayRateLimitOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetGatewayRateLimitOutput
dataclass
¶
Bases: _SerdeShape
Shared fields for GatewayRateLimit responses.
Attributes¶
description
class-attribute
instance-attribute
¶
description: str | None = ...
The human-readable description of the rate limit.
dimension_keys
instance-attribute
¶
The ordered list of dimension key names that define the scope of this rate limit.
entries
instance-attribute
¶
entries: list[LimitEntry]
The list of rule entries that map dimension values to rate configurations.
gateway_identifier
instance-attribute
¶
gateway_identifier: str
The unique identifier of the gateway.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.