regions

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

Overview

Name	regions
Type	Resource
Id	confluent.schema_registry_clusters.regions

Fields

The following fields are returned by SELECT queries:

get_srcm_v2_region

Region.

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. (srcm/v2)
kind	string	Kind defines the object this REST resource represents. (Region)
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 Region

list_srcm_v2_regions

Region.

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. (srcm/v2)
kind	string	Kind defines the object this REST resource represents. (Region)
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 Region

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_srcm_v2_region	select	id		Make a request to read a region.
list_srcm_v2_regions	select		spec.cloud, spec.region_name, spec.packages, page_size, page_token	Retrieve a sorted, filtered, paginated list of all regions.

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 region.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
spec.cloud	string	Filter the results by exact match for spec.cloud. (example: AWS)
spec.packages	array	Filter the results by exact match for spec.packages. Pass multiple times to see results matching any of the values. (example: [ESSENTIALS, ADVANCED])
spec.region_name	string	Filter the results by exact match for spec.region_name. (example: us-east-2)

SELECT examples

get_srcm_v2_region

Make a request to read a region.

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

list_srcm_v2_regions

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

SELECT
id,
api_version,
kind,
metadata,
spec
FROM confluent.schema_registry_clusters.regions
WHERE spec.cloud = '{{ spec.cloud }}'
AND spec.region_name = '{{ spec.region_name }}'
AND spec.packages = '{{ spec.packages }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;