consumer_assignments
Creates, updates, deletes, gets or lists a consumer_assignments resource.
Overview
| Name | consumer_assignments |
| Type | Resource |
| Id | confluent.share_group.consumer_assignments |
Fields
The following fields are returned by SELECT queries:
- list_kafka_share_group_consumer_assignments
The list of share group assignments.
| Name | Datatype | Description |
|---|---|---|
cluster_id | string | |
consumer_id | string | |
group_id | string | |
partition_id | integer | |
topic_name | string | |
kind | string | |
metadata | object | |
partition | object |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_kafka_share_group_consumer_assignments | select | cluster_id, group_id, consumer_id | Return 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.
| 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
- list_kafka_share_group_consumer_assignments
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
;