Skip to main content

client_quotas

Creates, updates, deletes, gets or lists a client_quotas resource.

Overview

Nameclient_quotas
TypeResource
Idconfluent.quotas.client_quotas

Fields

NameDatatypeDescription
idstringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
_specobject
api_versionstringAPIVersion defines the schema version of this representation of a resource.
kindstringKind defines the object this REST resource represents.
metadata``ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
specobjectThe desired state of the Client Quota

Methods

NameAccessible byRequired ParamsDescription
get_kafka_quotas_v1client_quotaSELECTidGeneral Availability Make a request to read a client quota.
list_kafka_quotas_v1client_quotasSELECTenvironment, spec.clusterGeneral Availability Retrieve a sorted, filtered, paginated list of all client quotas.
create_kafka_quotas_v1client_quotaINSERTGeneral Availability Make a request to create a client quota.
delete_kafka_quotas_v1client_quotaDELETEidGeneral Availability Make a request to delete a client quota.
update_kafka_quotas_v1client_quotaUPDATEidGeneral Availability Make a request to update a client quota.

SELECT examples

General Availability Make a request to read a client quota.

SELECT
id,
_spec,
api_version,
kind,
metadata,
spec
FROM confluent.quotas.client_quotas
WHERE id = '{{ id }}';

INSERT example

Use the following StackQL query and manifest file to create a new client_quotas resource.

/*+ create */
INSERT INTO confluent.quotas.client_quotas (
data__spec
)
SELECT
'{{ spec }}'
;

UPDATE example

Updates a client_quotas resource.

/*+ update */
UPDATE confluent.quotas.client_quotas
SET
spec = '{{ spec }}'
WHERE
id = '{{ id }}';

DELETE example

Deletes the specified client_quotas resource.

/*+ delete */
DELETE FROM confluent.quotas.client_quotas
WHERE id = '{{ id }}';