Class Topic (0.8.0) 

public final class Topic extends GeneratedMessageV3 implements TopicOrBuilder

A Kafka topic in a given cluster.

Protobuf type google.cloud.managedkafka.v1.Topic

Inheritance

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

Implements

TopicOrBuilder

Static Fields

CONFIGS_FIELD_NUMBER

public static final int CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_COUNT_FIELD_NUMBER

public static final int PARTITION_COUNT_FIELD_NUMBER
Field Value
Type Description
int

REPLICATION_FACTOR_FIELD_NUMBER

public static final int REPLICATION_FACTOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Topic getDefaultInstance()
Returns
Type Description
Topic

getDescriptor()

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

newBuilder()

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

newBuilder(Topic prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsConfigs(String key)

public boolean containsConfigs(String key)

Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy, compression.type.

map<string, string> configs = 4 [(.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

getConfigs() (deprecated)

public Map<String,String> getConfigs()

Use #getConfigsMap() instead.

Returns
Type Description
Map<String,String>

getConfigsCount()

public int getConfigsCount()

Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy, compression.type.

map<string, string> configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getConfigsMap()

public Map<String,String> getConfigsMap()

Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy, compression.type.

map<string, string> configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getConfigsOrDefault(String key, String defaultValue)

public String getConfigsOrDefault(String key, String defaultValue)

Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy, compression.type.

map<string, string> configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getConfigsOrThrow(String key)

public String getConfigsOrThrow(String key)

Optional. Configurations for the topic that are overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy, compression.type.

map<string, string> configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public Topic getDefaultInstanceForType()
Returns
Type Description
Topic

getName()

public String getName()

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPartitionCount()

public int getPartitionCount()

Required. The number of partitions this topic has. The partition count can only be increased, not decreased. Please note that if partitions are increased for a topic that has a key, the partitioning logic or the ordering of the messages will be affected.

int32 partition_count = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The partitionCount.

getReplicationFactor()

public int getReplicationFactor()

Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.

int32 replication_factor = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The replicationFactor.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 Topic.Builder newBuilderForType()
Returns
Type Description
Topic.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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