Skip to main content

regions

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

Overview

Nameregions
TypeResource
Idconfluent.tableflow.regions

Fields

The following fields are returned by SELECT queries:

Region.

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"). (example: dlz-f3a90de)
api_versionstringAPIVersion defines the schema version of this representation of a resource. (tableflow/v1)
cloudstringThe cloud service provider that hosts the region. (example: AWS)
kindstringKind defines the object this REST resource represents. (Region)
metadataobjectObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
regionstringThe cloud service provider region. (example: us-east-2)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_tableflow_v1_regionsselectcloud, page_size, page_tokenRetrieve 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.

NameDatatypeDescription
cloudstringFilter the results by exact match for cloud. (example: AWS)
page_sizeintegerA pagination size for collection requests.
page_tokenstringAn opaque pagination token for collection requests.

SELECT examples

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

SELECT
id,
api_version,
cloud,
kind,
metadata,
region
FROM confluent.tableflow.regions
WHERE cloud = '{{ cloud }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;