TsgcWSPClient_Kafka › Methods › DescribeGroups

DescribeGroups Method

Returns detailed information about the given consumer groups.

Syntax

function DescribeGroups(const aGroupIds: array of string): TsgcKafkaDescribeGroupsResponse;

Parameters

• aGroupIds: array of consumer group identifiers to describe.

Remarks

Returns a TsgcKafkaDescribeGroupsResponse with detailed information about each requested consumer group, including its state, protocol, members and partition assignments. Use ListGroups first to discover the available group identifiers.

Example

oGroups := oKafka.DescribeGroups(['my-consumer-group']);

Back to Methods