environments

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

Overview

Name	environments
Type	Resource
Id	confluent.org.environments

Fields

vw_environments

Name	Datatype	Description
id	text	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").
api_version	text	APIVersion defines the schema version of this representation of a resource.
created_at	text	field from the parent object
display_name	text	A human-readable name for the Environment
kind	text	Kind defines the object this REST resource represents.
resource_name	text	field from the parent object
self	text	field from the parent object
stream_governance_package	text	field from the parent object
updated_at	text	field from the parent object

environments

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").
api_version	string	APIVersion defines the schema version of this representation of a resource.
display_name	string	A human-readable name for the Environment
kind	string	Kind defines the object this REST resource represents.
metadata	``	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

Name	Accessible by	Required Params	Description
get_org_v2environment	SELECT	id	Make a request to read an environment.
list_org_v2environments	SELECT		Retrieve a sorted, filtered, paginated list of all environments.
create_org_v2environment	INSERT		Make a request to create an environment.
delete_org_v2environment	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.
update_org_v2environment	UPDATE	id	Make a request to update an environment.

SELECT examples

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

vw_environments

SELECT
id,
api_version,
created_at,
display_name,
kind,
resource_name,
self,
stream_governance_package,
updated_at
FROM confluent.org.vw_environments
;

environments

SELECT
id,
api_version,
display_name,
kind,
metadata,
stream_governance_config
FROM confluent.org.environments
;

INSERT example

Use the following StackQL query and manifest file to create a new environments resource.

Required Properties

/*+ create */
INSERT INTO confluent.org.environments (
data__display_name,
data__stream_governance_config
)
SELECT 
'{{ display_name }}',
'{{ stream_governance_config }}'
;

All Properties

/*+ create */
INSERT INTO confluent.org.environments (
data__display_name
)
SELECT 
'{{ display_name }}'
;

Manifest

- name: environments
  props:
    - name: display_name
      value: string
    - name: stream_governance_config
      props:
        - name: package
          value: string

UPDATE example

Updates a environments resource.

/*+ update */
UPDATE confluent.org.environments
SET 
display_name = '{{ display_name }}',
stream_governance_config = '{{ stream_governance_config }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified environments resource.

/*+ delete */
DELETE FROM confluent.org.environments
WHERE id = '{{ id }}';