streams_groups

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

Overview

Name	streams_groups
Type	Resource
Id	kafka.streams_group.streams_groups

Fields

The following fields are returned by SELECT queries:

get_kafka_streams_group

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.
group_epoch	integer	The epoch of the Streams group.
kind	string
member_count	integer	The number of members in the Streams group.
members	object
metadata	object
state	string	The state of the Streams group.
subtopologies	object
subtopology_count	integer	The number of subtopologies in the Streams group.
target_assignment_epoch	integer	The epoch of the target assignment.
topology_epoch	integer	The epoch of the Streams topology.

list_kafka_streams_groups

The list of streams groups.

Name	Datatype	Description
cluster_id	string	The unique identifier of the Kafka cluster.
group_id	string	The unique identifier of the Streams group.
group_epoch	integer	The epoch of the Streams group.
kind	string
member_count	integer	The number of members in the Streams group.
members	object
metadata	object
state	string	The state of the Streams group.
subtopologies	object
subtopology_count	integer	The number of subtopologies in the Streams group.
target_assignment_epoch	integer	The epoch of the target assignment.
topology_epoch	integer	The epoch of the Streams topology.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_streams_group	select	cluster_id, group_id, kafka_endpoint_id, region, cloud_provider		Return the streams group specified by the group_id.
list_kafka_streams_groups	select	cluster_id, kafka_endpoint_id, region, cloud_provider		Return the list of streams groups that belong to the specified Kafka cluster

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)

SELECT examples

get_kafka_streams_group

Return the streams group specified by the group_id.

SELECT
cluster_id,
group_id,
group_epoch,
kind,
member_count,
members,
metadata,
state,
subtopologies,
subtopology_count,
target_assignment_epoch,
topology_epoch
FROM kafka.streams_group.streams_groups
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
;

list_kafka_streams_groups

Return the list of streams groups that belong to the specified Kafka cluster

SELECT
cluster_id,
group_id,
group_epoch,
kind,
member_count,
members,
metadata,
state,
subtopologies,
subtopology_count,
target_assignment_epoch,
topology_epoch
FROM kafka.streams_group.streams_groups
WHERE cluster_id = '{{ cluster_id }}' -- required
AND kafka_endpoint_id = '{{ kafka_endpoint_id }}' -- required
AND region = '{{ region }}' -- required
AND cloud_provider = '{{ cloud_provider }}' -- required
;