public static final class ConsumerGroup.Builder extends GeneratedMessageV3.Builder<ConsumerGroup.Builder> implements ConsumerGroupOrBuilder
A Kafka consumer group in a given cluster.
Protobuf type google.cloud.managedkafka.v1.ConsumerGroup
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ConsumerGroup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public ConsumerGroup build()
buildPartial()
public ConsumerGroup buildPartial()
clear()
public ConsumerGroup.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public ConsumerGroup.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearName()
public ConsumerGroup.Builder clearName()
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public ConsumerGroup.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearTopics()
public ConsumerGroup.Builder clearTopics()
clone()
public ConsumerGroup.Builder clone()
Overrides
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
|
getDefaultInstanceForType()
public ConsumerGroup getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMutableTopics() (deprecated)
public Map<String,ConsumerTopicMetadata> getMutableTopics()
Use alternate mutation accessors instead.
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.
|
getTopics() (deprecated)
public Map<String,ConsumerTopicMetadata> getTopics()
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];
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];
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
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.Builder.internalGetMapFieldReflection(int)
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(ConsumerGroup other)
public ConsumerGroup.Builder mergeFrom(ConsumerGroup other)
public ConsumerGroup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public ConsumerGroup.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ConsumerGroup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public ConsumerGroup.Builder putAllTopics(Map<String,ConsumerTopicMetadata> values)
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];
public ConsumerGroup.Builder putTopics(String key, ConsumerTopicMetadata value)
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];
putTopicsBuilderIfAbsent(String key)
public ConsumerTopicMetadata.Builder putTopicsBuilderIfAbsent(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
|
removeTopics(String key)
public ConsumerGroup.Builder removeTopics(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
|
setField(Descriptors.FieldDescriptor field, Object value)
public ConsumerGroup.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setName(String value)
public ConsumerGroup.Builder setName(String value)
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];
| Parameter |
| Name |
Description |
value |
String
The name to set.
|
setNameBytes(ByteString value)
public ConsumerGroup.Builder setNameBytes(ByteString value)
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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ConsumerGroup.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final ConsumerGroup.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
