TopicState class

Input properties used for looking up and filtering Topic resources.

Constructors

TopicState({Input<String?>? cluster, Input<Map<String, String>?>? configs, Input<String?>? deletionPolicy, Input<String?>? location, Input<String?>? name, Input<int?>? partitionCount, Input<String?>? project, Input<int?>? replicationFactor, Input<String?>? topicId})
Creates a new TopicState. cluster The cluster name. configs Configuration 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=compact, compression.type=producer. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. location ID of the location of the Kafka resource. See https://cloud.google.com/managed-kafka/docs/locations for a list of supported locations. name The name of the topic. The topic segment is used when connecting directly to the cluster. Must be in the format projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID. partitionCount The number of partitions in a topic. You can increase the partition count for a topic, but you cannot decrease it. Increasing partitions for a topic that uses a key might change how messages are distributed. project The ID of the project in which the resource belongs. replicationFactor The number of replicas of each partition. A replication factor of 3 is recommended for high availability. topicId The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
const
TopicState.fromMap(Map<String, dynamic> map)
factory

Properties

cluster → Input<String?>?
The cluster name.
final
configs → Input<Map<String, String>?>?
Configuration 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=compact, compression.type=producer.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<String?>?
ID of the location of the Kafka resource. See https://cloud.google.com/managed-kafka/docs/locations for a list of supported locations.
final
name → Input<String?>?
The name of the topic. The topic segment is used when connecting directly to the cluster. Must be in the format projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID.
final
partitionCount → Input<int?>?
The number of partitions in a topic. You can increase the partition count for a topic, but you cannot decrease it. Increasing partitions for a topic that uses a key might change how messages are distributed.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
replicationFactor → Input<int?>?
The number of replicas of each partition. A replication factor of 3 is recommended for high availability.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
topicId → Input<String?>?
The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: my-topic-name.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited