applied_quotas

Creates, updates, deletes, gets or lists an applied_quotas resource.

Overview

Name	applied_quotas
Type	Resource
Id	confluent.quotas.applied_quotas

Fields

The following fields are returned by SELECT queries:

get_service_quota_v1_applied_quota

Applied 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)
display_name	string	A human-readable name for the quota type name. (example: Kafka Cluster Per Organization)
api_version	string	APIVersion defines the schema version of this representation of a resource. (service-quota/v1)
applied_limit	integer (int32)	The latest applied service quota value, taking into account any limit adjustments.
default_limit	integer (int32)	The default service quota value.
environment	object	The environment ID the quota is associated with.
kafka_cluster	object	The kafka cluster ID the quota is associated with.
kind	string	Kind defines the object this REST resource represents. (AppliedQuota)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
network	object	The network ID the quota is associated with.
organization	object	A unique organization id to associate a specific organization to this quota.
scope	string	The applied scope that this quota belongs to. (example: ORGANIZATION)
usage	integer (int32)	Show the quota usage value if the quota usage is available for this quota.
user	object	The user associated with this object.

list_service_quota_v1_applied_quotas

Applied 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)
display_name	string	A human-readable name for the quota type name. (example: Kafka Cluster Per Organization)
api_version	string	APIVersion defines the schema version of this representation of a resource. (service-quota/v1)
applied_limit	integer (int32)	The latest applied service quota value, taking into account any limit adjustments.
default_limit	integer (int32)	The default service quota value.
environment	object	The environment ID the quota is associated with.
kafka_cluster	object	The kafka cluster ID the quota is associated with.
kind	string	Kind defines the object this REST resource represents. (AppliedQuota)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
network	object	The network ID the quota is associated with.
organization	object	A unique organization id to associate a specific organization to this quota.
scope	string	The applied scope that this quota belongs to. (example: ORGANIZATION)
usage	integer (int32)	Show the quota usage value if the quota usage is available for this quota.
user	object	The user associated with this object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_quota_v1_applied_quota	select	id	environment, network, kafka_cluster	Make a request to read an applied quota.
list_service_quota_v1_applied_quotas	select	scope	environment, network, kafka_cluster, id, page_size, page_token	Retrieve a sorted, filtered, paginated list of all applied quotas. Shows all quotas for a given scope.

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
id	string	The unique identifier for the applied quota.
scope	string	The applied scope the quota belongs to. (example: ORGANIZATION)
environment	string	The environment ID the quota is associated with. (example: env-00000)
id	string	The id (quota code) that this quota belongs to. (example: iam.max_environments.per_org)
kafka_cluster	string	The kafka cluster ID the quota is associated with. (example: lkc-00000)
network	string	The network ID the quota is associated with. (example: n-12034)
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_service_quota_v1_applied_quota

Make a request to read an applied quota.

SELECT
id,
display_name,
api_version,
applied_limit,
default_limit,
environment,
kafka_cluster,
kind,
metadata,
network,
organization,
scope,
usage,
user
FROM confluent.quotas.applied_quotas
WHERE id = '{{ id }}' -- required
AND environment = '{{ environment }}'
AND network = '{{ network }}'
AND kafka_cluster = '{{ kafka_cluster }}'
;

list_service_quota_v1_applied_quotas

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

Shows all quotas for a given scope.

SELECT
id,
display_name,
api_version,
applied_limit,
default_limit,
environment,
kafka_cluster,
kind,
metadata,
network,
organization,
scope,
usage,
user
FROM confluent.quotas.applied_quotas
WHERE scope = '{{ scope }}' -- required
AND environment = '{{ environment }}'
AND network = '{{ network }}'
AND kafka_cluster = '{{ kafka_cluster }}'
AND id = '{{ id }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;