Skip to main content

consumer_assignments

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

Overview

Nameconsumer_assignments
TypeResource
Idconfluent.share_group.consumer_assignments

Fields

The following fields are returned by SELECT queries:

The list of share group assignments.

NameDatatypeDescription
cluster_idstring
consumer_idstring
group_idstring
partition_idinteger
topic_namestring
kindstring
metadataobject
partitionobject

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_kafka_share_group_consumer_assignmentsselectcluster_id, group_id, consumer_idReturn the consumer assignments specified by the consumer_id.

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.

NameDatatypeDescription
cluster_idstringThe Kafka cluster ID. (example: cluster-1)
consumer_idstringThe consumer ID. (example: consumer-1)
group_idstringThe group ID. (example: group-1)

SELECT examples

Return the consumer assignments specified by the consumer_id.

SELECT
cluster_id,
consumer_id,
group_id,
partition_id,
topic_name,
kind,
metadata,
partition
FROM confluent.share_group.consumer_assignments
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND consumer_id = '{{ consumer_id }}' -- required
;