Resource: Topic
A topic resource.
JSON representation |
---|
{ "name": string, "labels": { string: string, ... }, "messageStoragePolicy": { object ( |
Fields | |
---|---|
name |
Required. Name of the topic. Format is |
labels |
See Creating and managing labels. An object containing a list of |
messageStoragePolicy |
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. |
kmsKeyName |
The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is |
schemaSettings |
Settings for validating messages published against a schema. |
satisfiesPzs |
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. |
messageRetentionDuration |
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 A duration in seconds with up to nine fractional digits, terminated by ' |
MessageStoragePolicy
A policy constraining the storage of messages published to the topic.
JSON representation |
---|
{ "allowedPersistenceRegions": [ string ] } |
Fields | |
---|---|
allowedPersistenceRegions[] |
A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration. |
SchemaSettings
Settings for validating messages published against a schema.
JSON representation |
---|
{
"schema": string,
"encoding": enum ( |
Fields | |
---|---|
schema |
Required. The name of the schema that messages published should be validated against. Format is |
encoding |
The encoding of messages validated against |
firstRevisionId |
The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before. |
lastRevisionId |
The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after. |
Encoding
Possible encoding types for messages.
Enums | |
---|---|
ENCODING_UNSPECIFIED |
Unspecified |
JSON |
JSON encoding |
BINARY |
Binary encoding, as defined by the schema type. For some schema types, binary encoding may not be available. |
Methods |
|
---|---|
|
Creates the given topic with the given name. |
|
Deletes the topic with the given name. |
|
Gets the configuration of a topic. |
|
Gets the access control policy for a resource. |
|
Lists matching topics. |
|
Updates an existing topic. |
|
Adds one or more messages to the topic. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |