Class ConsumerGroup (0.18.0) 

public final class ConsumerGroup extends GeneratedMessageV3 implements ConsumerGroupOrBuilder

A Kafka consumer group in a given cluster.

Protobuf type google.cloud.managedkafka.v1.ConsumerGroup

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ConsumerGroup

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TOPICS_FIELD_NUMBER

public static final int TOPICS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConsumerGroup getDefaultInstance()
Returns
Type Description
ConsumerGroup

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConsumerGroup.Builder newBuilder()
Returns
Type Description
ConsumerGroup.Builder

newBuilder(ConsumerGroup prototype)

public static ConsumerGroup.Builder newBuilder(ConsumerGroup prototype)
Parameter
Name Description
prototype ConsumerGroup
Returns
Type Description
ConsumerGroup.Builder

parseDelimitedFrom(InputStream input)

public static ConsumerGroup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsumerGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConsumerGroup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConsumerGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConsumerGroup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConsumerGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConsumerGroup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsumerGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConsumerGroup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsumerGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConsumerGroup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConsumerGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerGroup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConsumerGroup> parser()
Returns
Type Description
Parser<ConsumerGroup>

Methods

containsTopics(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ConsumerGroup getDefaultInstanceForType()
Returns
Type Description
ConsumerGroup

getName()

public 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 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.

getParserForType()

public Parser<ConsumerGroup> getParserForType()
Returns
Type Description
Parser<ConsumerGroup>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTopics() (deprecated)

public Map<String,ConsumerTopicMetadata> getTopics()

Use #getTopicsMap() instead.

Returns
Type Description
Map<String,ConsumerTopicMetadata>

getTopicsCount()

public 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 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 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 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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConsumerGroup.Builder newBuilderForType()
Returns
Type Description
ConsumerGroup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConsumerGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConsumerGroup.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConsumerGroup.Builder toBuilder()
Returns
Type Description
ConsumerGroup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException