consumers

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

Overview

Name	consumers
Type	Resource
Id	confluent.share_group.consumers

Fields

The following fields are returned by SELECT queries:

get_kafka_share_group_consumer

The consumer.

Name	Datatype	Description
client_id	string
cluster_id	string
consumer_id	string
group_id	string
assignments	object
kind	string
metadata	object

list_kafka_share_group_consumers

The list of consumers.

Name	Datatype	Description
client_id	string
cluster_id	string
consumer_id	string
group_id	string
assignments	object
kind	string
metadata	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_share_group_consumer	select	cluster_id, group_id, consumer_id		Return the consumer specified by the consumer_id.
list_kafka_share_group_consumers	select	cluster_id, group_id		Return a list of consumers that belong to the specified share 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
cluster_id	string	The Kafka cluster ID. (example: cluster-1)
consumer_id	string	The consumer ID. (example: consumer-1)
group_id	string	The group ID. (example: group-1)

SELECT examples

get_kafka_share_group_consumer

Return the consumer specified by the consumer_id.

SELECT
client_id,
cluster_id,
consumer_id,
group_id,
assignments,
kind,
metadata
FROM confluent.share_group.consumers
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND consumer_id = '{{ consumer_id }}' -- required
;

list_kafka_share_group_consumers

Return a list of consumers that belong to the specified share
group.

SELECT
client_id,
cluster_id,
consumer_id,
group_id,
assignments,
kind,
metadata
FROM confluent.share_group.consumers
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- required
;