client_quotas

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

Overview

Name	client_quotas
Type	Resource
Id	confluent.quotas.client_quotas

Fields

The following fields are returned by SELECT queries:

get_kafka_quotas_v1_client_quota

Client Quota.

Name	Datatype	Description
id	string	ID 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"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (kafka-quotas/v1)
kind	string	Kind defines the object this REST resource represents. (ClientQuota)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Client Quota

list_kafka_quotas_v1_client_quotas

Client Quota.

Name	Datatype	Description
id	string	ID 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"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (kafka-quotas/v1)
kind	string	Kind defines the object this REST resource represents. (ClientQuota)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Client Quota

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_quotas_v1_client_quota	select	id		Make a request to read a client quota.
list_kafka_quotas_v1_client_quotas	select	spec.cluster, environment	page_size, page_token	Retrieve a sorted, filtered, paginated list of all client quotas.
create_kafka_quotas_v1_client_quota	insert			Make a request to create a client quota.
update_kafka_quotas_v1_client_quota	update	id, spec		Make a request to update a client quota.
delete_kafka_quotas_v1_client_quota	delete	id		Make a request to delete a client quota.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment	string	Filter the results by exact match for environment. (example: env-xxxxx)
id	string	The unique identifier for the client quota.
spec.cluster	string	Filter the results by exact match for spec.cluster. (example: lkc-xxxxx)
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_kafka_quotas_v1_client_quota

Make a request to read a client quota.

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

list_kafka_quotas_v1_client_quotas

Retrieve a sorted, filtered, paginated list of all client quotas.

SELECT
id,
api_version,
kind,
metadata,
spec
FROM confluent.quotas.client_quotas
WHERE spec.cluster = '{{ spec.cluster }}' -- required
AND environment = '{{ environment }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_kafka_quotas_v1_client_quota

Make a request to create a client quota.

INSERT INTO confluent.quotas.client_quotas (

)
SELECT 

RETURNING
id,
api_version,
kind,
metadata,
spec
;

Manifest

# Description fields are for documentation purposes
- name: client_quotas
props:

UPDATE examples

update_kafka_quotas_v1_client_quota

Make a request to update a client quota.

UPDATE confluent.quotas.client_quotas
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}' --required
AND spec = '{{ spec }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec;

DELETE examples

delete_kafka_quotas_v1_client_quota

Make a request to delete a client quota.

DELETE FROM confluent.quotas.client_quotas
WHERE id = '{{ id }}' --required
;