Topic

import type { Topic } from "https://googleapis.deno.dev/v1/pubsub:v1.ts";

A topic resource.

interface Topic {

ingestionDataSourceSettings?: IngestionDataSourceSettings;

kmsKeyName?: string;

labels?: {

[key: string]: string;

};

messageRetentionDuration?: number;

messageStoragePolicy?: MessageStoragePolicy;

name?: string;

satisfiesPzs?: boolean;

schemaSettings?: SchemaSettings;

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "INGESTION_RESOURCE_ERROR";

}

§Properties

ingestionDataSourceSettings?: IngestionDataSourceSettings

[src]

Optional. Settings for ingestion from a data source into this topic.

kmsKeyName?: string

[src]

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?: {

[key: string]: string;

}

[src]

Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).

messageRetentionDuration?: number

[src]

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?: MessageStoragePolicy

[src]

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?: string

[src]

Required. 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".

satisfiesPzs?: boolean

[src]

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?: SchemaSettings

[src]

Optional. Settings for validating messages published against a schema.

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "INGESTION_RESOURCE_ERROR"

[src]

Output only. An output-only field indicating the state of the topic.