regions
Creates, updates, deletes, gets or lists a regions resource.
Overview
| Name | regions |
| Type | Resource |
| Id | confluent.tableflow.regions |
Fields
The following fields are returned by SELECT queries:
- list_tableflow_v1_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. (tableflow/v1) |
cloud | string | The cloud service provider that hosts the region. (example: AWS) |
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. |
region | string | The cloud service provider region. (example: us-east-2) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_tableflow_v1_regions | select | cloud, 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 |
|---|---|---|
cloud | string | Filter the results by exact match for cloud. (example: AWS) |
page_size | integer | A pagination size for collection requests. |
page_token | string | An opaque pagination token for collection requests. |
SELECT examples
- list_tableflow_v1_regions
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 }}'
;