environments

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

Overview

Name	environments
Type	Resource
Id	confluent.org.environments

Fields

The following fields are returned by SELECT queries:

get_org_v2_environment

Environment.

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 Environment (example: prod-finance01)
api_version	string	APIVersion defines the schema version of this representation of a resource. (org/v2)
kind	string	Kind defines the object this REST resource represents. (Environment)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stream_governance_config	object	Stream Governance configurations for the environment

list_org_v2_environments

Environment.

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 Environment (example: prod-finance01)
api_version	string	APIVersion defines the schema version of this representation of a resource. (org/v2)
kind	string	Kind defines the object this REST resource represents. (Environment)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
stream_governance_config	object	Stream Governance configurations for the environment

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_org_v2_environment	select	id		Make a request to read an environment.
list_org_v2_environments	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all environments.
create_org_v2_environment	insert	display_name		Make a request to create an environment.
update_org_v2_environment	update	id		Make a request to update an environment.
delete_org_v2_environment	delete	id		Make a request to delete an environment. If successful, this request will also recursively delete all of the environment's associated resources, including all Kafka clusters, connectors, etc.

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 environment.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_org_v2_environment

Make a request to read an environment.

SELECT
id,
display_name,
api_version,
kind,
metadata,
stream_governance_config
FROM confluent.org.environments
WHERE id = '{{ id }}' -- required
;

list_org_v2_environments

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

SELECT
id,
display_name,
api_version,
kind,
metadata,
stream_governance_config
FROM confluent.org.environments
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_org_v2_environment

Make a request to create an environment.

INSERT INTO confluent.org.environments (
display_name,
stream_governance_config
)
SELECT 
'{{ display_name }}' /* required */,
'{{ stream_governance_config }}'
RETURNING
id,
display_name,
api_version,
kind,
metadata,
stream_governance_config
;

Manifest

# Description fields are for documentation purposes
- name: environments
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      A human-readable name for the Environment
  - name: stream_governance_config
    description: |
      Stream Governance configurations for the environment
    value:
      package: "{{ package }}"

UPDATE examples

update_org_v2_environment

Make a request to update an environment.

UPDATE confluent.org.environments
SET 
display_name = '{{ display_name }}',
stream_governance_config = '{{ stream_governance_config }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
display_name,
api_version,
kind,
metadata,
stream_governance_config;

DELETE examples

delete_org_v2_environment

Make a request to delete an environment.

If successful, this request will also recursively delete all of the environment's associated resources,
including all Kafka clusters, connectors, etc.

DELETE FROM confluent.org.environments
WHERE id = '{{ id }}' --required
;