Skip to content

rules

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

AdminQuotaGroupsRules

The admin.quota.groups.rules namespace.

add

add(quotagroup: str, quotarule: str) -> None

Adds a rule to a quota group.

Parameters:

Name Type Description Default
quotagroup str

quota group to add a rule to

required
quotarule str

the name of the quota rule to add to the group

required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: adminAddRuleToQuotaGroup

remove

remove(quotagroup: str, quotarule: str) -> None

Removes a rule from a quota group.

Parameters:

Name Type Description Default
quotagroup str

quota group to remove a rule from

required
quotarule str

the name of the quota rule to remove from the group

required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: adminRemoveRuleFromQuotaGroup

AsyncAdminQuotaGroupsRules

The admin.quota.groups.rules namespace.

add

add(quotagroup: str, quotarule: str) -> None

Adds a rule to a quota group.

Parameters:

Name Type Description Default
quotagroup str

quota group to add a rule to

required
quotarule str

the name of the quota rule to add to the group

required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: adminAddRuleToQuotaGroup

remove

remove(quotagroup: str, quotarule: str) -> None

Removes a rule from a quota group.

Parameters:

Name Type Description Default
quotagroup str

quota group to remove a rule from

required
quotarule str

the name of the quota rule to remove from the group

required

Returns:

Type Description
None

No content.

Raises:

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

Operation ID: adminRemoveRuleFromQuotaGroup