TopicState class

Input properties used for looking up and filtering Topic resources.

Constructors

TopicState({Input<String?>? deletionPolicy, Input<Map<String, String>?>? effectiveLabels, Input<TopicIngestionDataSourceSettings?>? ingestionDataSourceSettings, Input<String?>? kmsKeyName, Input<Map<String, String>?>? labels, Input<String?>? messageRetentionDuration, Input<TopicMessageStoragePolicy?>? messageStoragePolicy, Input<List<TopicMessageTransform>?>? messageTransforms, Input<String?>? name, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<TopicSchemaSettings?>? schemaSettings, Input<Map<String, String>?>? tags})
Creates a new TopicState. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. ingestionDataSourceSettings Settings for ingestion from a data source into this topic. kmsKeyName The resource name of the Cloud KMS CryptoKey to be used to protect access labels A set of key/value label pairs to assign to this Topic. messageRetentionDuration Indicates the minimum duration to retain a message after it is published messageStoragePolicy Policy constraining the set of Google Cloud Platform regions where messageTransforms Transforms to be applied to messages published to the topic. Transforms are applied in the name Name of the topic. project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource schemaSettings Settings for validating messages published against a schema. tags Input only. Resource manager tags to be bound to the topic. Tag keys and
const
TopicState.fromMap(Map<String, dynamic> map)
factory

Properties

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
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
hashCode → int
The hash code for this object.
no setterinherited
ingestionDataSourceSettings → Input<TopicIngestionDataSourceSettings?>?
Settings for ingestion from a data source into this topic. Structure is documented below.
final
kmsKeyName → Input<String?>?
The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. Your project's PubSub service account (service-{{PROJECT_NUMBER}}@gcp-sa-pubsub.iam.gserviceaccount.com) must have roles/cloudkms.cryptoKeyEncrypterDecrypter to use this feature. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*
final
labels → Input<Map<String, String>?>?
A set of key/value label pairs to assign to this Topic.
final
messageRetentionDuration → Input<String?>?
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 messageRetentionDuration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to messageRetentionDuration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. The rotation period has the format of a decimal number, followed by the letter s (seconds). Cannot be more than 31 days or less than 10 minutes.
final
messageStoragePolicy → Input<TopicMessageStoragePolicy?>?
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. Structure is documented below.
final
messageTransforms → Input<List<TopicMessageTransform>?>?
Transforms to be applied to messages published to the topic. Transforms are applied in the order specified. Structure is documented below.
final
name → Input<String?>?
Name of the topic.
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
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaSettings → Input<TopicSchemaSettings?>?
Settings for validating messages published against a schema. Structure is documented below.
final
tags → Input<Map<String, String>?>?
Input only. Resource manager tags to be bound to the topic. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored when empty. The field is immutable and causes resource replacement when mutated. This field is only set at create time and modifying this field after creation will trigger recreation. To apply tags to an existing resource, see the gcp.tags.TagValue resource.
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