Interface ConsumerGroupOrBuilder (0.8.0) 

public interface ConsumerGroupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsTopics(String key)

public abstract boolean containsTopics(String key)

Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}

map<string, .google.cloud.managedkafka.v1.ConsumerTopicMetadata> topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getName()

public abstract String getName()

Identifier. The name of the consumer group. The consumer_group segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The name of the consumer group. The consumer_group segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getTopics() (deprecated)

public abstract Map<String,ConsumerTopicMetadata> getTopics()

Use #getTopicsMap() instead.

Returns
Type Description
Map<String,ConsumerTopicMetadata>

getTopicsCount()

public abstract int getTopicsCount()

Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}

map<string, .google.cloud.managedkafka.v1.ConsumerTopicMetadata> topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTopicsMap()

public abstract Map<String,ConsumerTopicMetadata> getTopicsMap()

Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}

map<string, .google.cloud.managedkafka.v1.ConsumerTopicMetadata> topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,ConsumerTopicMetadata>

getTopicsOrDefault(String key, ConsumerTopicMetadata defaultValue)

public abstract ConsumerTopicMetadata getTopicsOrDefault(String key, ConsumerTopicMetadata defaultValue)

Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}

map<string, .google.cloud.managedkafka.v1.ConsumerTopicMetadata> topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue ConsumerTopicMetadata
Returns
Type Description
ConsumerTopicMetadata

getTopicsOrThrow(String key)

public abstract ConsumerTopicMetadata getTopicsOrThrow(String key)

Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}

map<string, .google.cloud.managedkafka.v1.ConsumerTopicMetadata> topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
ConsumerTopicMetadata