scopes

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

Overview

Name	scopes
Type	Resource
Id	confluent.quotas.scopes

Fields

The following fields are returned by SELECT queries:

get_service_quota_v1_scope

Scope.

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. (service-quota/v1)
description	string	the quota scope for listing quotas queries (example: ORGANIZATION scope that quotas would be applied to)
kind	string	Kind defines the object this REST resource represents. (Scope)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

list_service_quota_v1_scopes

Scope.

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. (service-quota/v1)
description	string	the quota scope for listing quotas queries (example: ORGANIZATION scope that quotas would be applied to)
kind	string	Kind defines the object this REST resource represents. (Scope)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_quota_v1_scope	select	id		Make a request to read a scope.
list_service_quota_v1_scopes	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all scopes.

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 scope.
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_scope

Make a request to read a scope.

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

list_service_quota_v1_scopes

Retrieve a sorted, filtered, paginated list of all scopes.

SELECT
id,
api_version,
description,
kind,
metadata
FROM confluent.quotas.scopes
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;