subtopologies

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

Overview

Name	subtopologies
Type	Resource
Id	kafka.streams_group.subtopologies

Fields

The following fields are returned by SELECT queries:

get_kafka_streams_group_subtopology

The streams group subtopology.

Name	Datatype	Description
cluster_id	string	The unique identifier of the Kafka cluster.
group_id	string	The unique identifier of the Streams group.
subtopology_id	string	The unique identifier of the Streams subtopology.
kind	string
metadata	object
source_topics	array	The list of source topics for the subtopology.

list_kafka_streams_group_subtopologies

The list of subtoplogies of the streams group

Name	Datatype	Description
cluster_id	string	The unique identifier of the Kafka cluster.
group_id	string	The unique identifier of the Streams group.
subtopology_id	string	The unique identifier of the Streams subtopology.
kind	string
metadata	object
source_topics	array	The list of source topics for the subtopology.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_streams_group_subtopology	select	cluster_id, group_id, subtopology_id, kafka_endpoint_id, region, cloud_provider		Return the subtopology specified by the subtopology_id.
list_kafka_streams_group_subtopologies	select	cluster_id, group_id, kafka_endpoint_id, region, cloud_provider		Return a list of subtopologies that belong to the specified streams group.

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_provider	string	Cloud provider, lowercase: aws, gcp, or azure (from the cluster spec.cloud). (default: cloud)
cluster_id	string	The Kafka cluster ID. (example: cluster-1)
group_id	string	The group ID. (example: group-1)
kafka_endpoint_id	string	Per-cluster Kafka REST endpoint ID (the pkc-* host prefix from the Confluent UI Cluster -> Overview -> REST endpoint, or extract from confluent.managed_kafka_clusters.clusters spec.http_endpoint). (default: pkc-00000)
region	string	Cloud region the cluster runs in, e.g. ap-southeast-2 (from the cluster spec.region). (default: region)
subtopology_id	string	The streams subtopology ID. (example: subtopology-1)

SELECT examples

get_kafka_streams_group_subtopology

Return the subtopology specified by the subtopology_id.

SELECT
cluster_id,
group_id,
subtopology_id,
kind,
metadata,
source_topics
FROM kafka.streams_group.subtopologies
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND subtopology_id = '{{ subtopology_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;

list_kafka_streams_group_subtopologies

Return a list of subtopologies that belong to the specified streams group.

SELECT
cluster_id,
group_id,
subtopology_id,
kind,
metadata,
source_topics
FROM kafka.streams_group.subtopologies
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;