pipelines

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

Overview

Name	pipelines
Type	Resource
Id	confluent.pipelines.pipelines

Fields

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").
_spec	object
api_version	string	APIVersion defines the schema version of this representation of a resource.
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.
spec	object	The desired state of the Pipeline
status	object	The status of the Pipeline

Methods

Name	Accessible by	Required Params	Description
get_sd_v1pipeline	SELECT	environment, id, spec.kafka_cluster	Make a request to read a pipeline.
list_sd_v1pipelines	SELECT	environment, spec.kafka_cluster	Retrieve a sorted, filtered, paginated list of all pipelines.
create_sd_v1pipeline	INSERT		Make a request to create a pipeline.
delete_sd_v1pipeline	DELETE	environment, id, spec.kafka_cluster	Make a request to delete a pipeline.
update_sd_v1pipeline	UPDATE	id	Make a request to update a pipeline.

SELECT examples

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

SELECT
id,
_spec,
api_version,
kind,
metadata,
spec,
status
FROM confluent.pipelines.pipelines
WHERE environment = '{{ environment }}'
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO confluent.pipelines.pipelines (
data__spec
)
SELECT 
'{{ spec }}'
;

Manifest

- name: pipelines
  props:
    - name: spec
      props:
        - name: environment
          value: string
        - name: kafka_cluster
          value: string

UPDATE example

Updates a pipelines resource.

/*+ update */
UPDATE confluent.pipelines.pipelines
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified pipelines resource.

/*+ delete */
DELETE FROM confluent.pipelines.pipelines
WHERE environment = '{{ environment }}'
AND id = '{{ id }}'
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}';