Managed Service for Apache Kafka V1 API - Class Google::Cloud::ManagedKafka::V1::Topic (v0.2.0)

Reference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::V1::Topic.

A Kafka topic in a given cluster.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#configs

def configs() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#configs=

def configs=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String
Returns
  • (::String) — 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}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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}
Returns
  • (::String) — 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}

#partition_count

def partition_count() -> ::Integer
Returns
  • (::Integer) — 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.

#partition_count=

def partition_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#replication_factor

def replication_factor() -> ::Integer
Returns
  • (::Integer) — Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.

#replication_factor=

def replication_factor=(value) -> ::Integer
Parameter
  • value (::Integer) — Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.
Returns
  • (::Integer) — Required. Immutable. The number of replicas of each partition. A replication factor of 3 is recommended for high availability.