TopicArgs class

The set of arguments for Topic. The set of arguments for Topic.

Constructors

TopicArgs({Input<String>? kmsKeyName, Input<Map<String, String>>? labels, Input<String>? messageRetentionDuration, Input<MessageStoragePolicy>? messageStoragePolicy, Input<String>? name, Input<String>? project, Input<bool>? satisfiesPzs, Input<SchemaSettings>? schemaSettings, required Input<String> topicId})
Creates a new TopicArgs. kmsKeyName Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*. labels Optional. See Creating and managing labels (https://cloud.google.com/pubsub/docs/labels). messageRetentionDuration Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. messageStoragePolicy Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect. name The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog". project Optional. satisfiesPzs Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. schemaSettings Optional. Settings for validating messages published against a schema. topicId Required.
const
TopicArgs.fromMap(Map<String, dynamic> map)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
kmsKeyName → Input<String>?
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.
final
labels → Input<Map<String, String>>?
Optional. See Creating and managing labels (https://cloud.google.com/pubsub/docs/labels).
final
messageRetentionDuration → Input<String>?
Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
final
messageStoragePolicy → Input<MessageStoragePolicy>?
Optional. Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
final
name → Input<String>?
The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs → Input<bool>?
Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
final
schemaSettings → Input<SchemaSettings>?
Optional. Settings for validating messages published against a schema.
final
topicId → Input<String>
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