rules

Accessed as client.admin.quota.rules; the async client mirrors it.

SyncAsync

AdminQuotaRules

The admin.quota.rules namespace.

create

create(*, limit: int | None = None, name: str | None = None, subjects: list[str] | None = None) -> QuotaRuleInfo

Create a new quota rule.

Parameters:

Name	Type	Description	Default
`limit`	`int \| None`	The limit set by the rule	`None`
`name`	`str \| None`	Name of the rule to create	`None`
`subjects`	`list[str] \| None`	The subjects affected by the rule	`None`

Returns:

Type	Description
`QuotaRuleInfo`	QuotaRuleInfo.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`ConflictError`	APIError is error format response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminCreateQuotaRule

delete

delete(quotarule: str) -> None

Deletes a quota rule.

Parameters:

Name	Type	Description	Default
`quotarule`	`str`	quota rule to delete	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminDeleteQuotaRule

get

get(quotarule: str) -> QuotaRuleInfo

Get information about a quota rule.

Parameters:

Name	Type	Description	Default
`quotarule`	`str`	quota rule to query	required

Returns:

Type	Description
`QuotaRuleInfo`	QuotaRuleInfo.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminGetQuotaRule

list

list() -> list[QuotaRuleInfo]

List the available quota rules.

Returns:

Type	Description
`list[QuotaRuleInfo]`	QuotaRuleInfoList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminListQuotaRules

update

update(quotarule: str, *, limit: int | None = None, subjects: list[str] | None = None) -> QuotaRuleInfo

Change an existing quota rule.

Parameters:

Name	Type	Description	Default
`quotarule`	`str`	Quota rule to change	required
`limit`	`int \| None`	The limit set by the rule	`None`
`subjects`	`list[str] \| None`	The subjects affected by the rule	`None`

Returns:

Type	Description
`QuotaRuleInfo`	QuotaRuleInfo.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminEditQuotaRule

AsyncAdminQuotaRules

The admin.quota.rules namespace.

create

create(*, limit: int | None = None, name: str | None = None, subjects: list[str] | None = None) -> QuotaRuleInfo

Create a new quota rule.

Parameters:

Name	Type	Description	Default
`limit`	`int \| None`	The limit set by the rule	`None`
`name`	`str \| None`	Name of the rule to create	`None`
`subjects`	`list[str] \| None`	The subjects affected by the rule	`None`

Returns:

Type	Description
`QuotaRuleInfo`	QuotaRuleInfo.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`ConflictError`	APIError is error format response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminCreateQuotaRule

delete

delete(quotarule: str) -> None

Deletes a quota rule.

Parameters:

Name	Type	Description	Default
`quotarule`	`str`	quota rule to delete	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminDeleteQuotaRule

get

get(quotarule: str) -> QuotaRuleInfo

Get information about a quota rule.

Parameters:

Name	Type	Description	Default
`quotarule`	`str`	quota rule to query	required

Returns:

Type	Description
`QuotaRuleInfo`	QuotaRuleInfo.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminGetQuotaRule

list

list() -> list[QuotaRuleInfo]

List the available quota rules.

Returns:

Type	Description
`list[QuotaRuleInfo]`	QuotaRuleInfoList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminListQuotaRules

update

update(quotarule: str, *, limit: int | None = None, subjects: list[str] | None = None) -> QuotaRuleInfo

Change an existing quota rule.

Parameters:

Name	Type	Description	Default
`quotarule`	`str`	Quota rule to change	required
`limit`	`int \| None`	The limit set by the rule	`None`
`subjects`	`list[str] \| None`	The subjects affected by the rule	`None`

Returns:

Type	Description
`QuotaRuleInfo`	QuotaRuleInfo.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminEditQuotaRule