Method: projects.topics.patch

HTTP request
Path parameters
Request body
- JSON representation
Response body
Authorization scopes
Try it!

Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.

HTTP request

Choose a location:

PATCH https://pubsub.googleapis.com/v1/{topic.name}

Path parameters

Parameters

Parameters
`topic.name`	`string` Required. Identifier. Name of the topic. Format is `projects/{project}/topics/{topic}`.

topic.name

string

Required. Identifier. Name of the topic. Format is projects/{project}/topics/{topic}.

Request body

The request body contains data with the following structure:

JSON representation

JSON representation
{ "topic": { "name": string, "labels": { string: string, ... }, "messageStoragePolicy": { "allowedPersistenceRegions": [ string ], "enforceInTransit": boolean }, "kmsKeyName": string, "schemaSettings": { "schema": string, "encoding": enum (`Encoding` ), "firstRevisionId": string, "lastRevisionId": string }, "satisfiesPzs": boolean, "messageRetentionDuration": string, "state": enum (`State` ), "ingestionDataSourceSettings": { "platformLogsSettings": { object (`PlatformLogsSettings` ) }, // Union field `source` can be only one of the following: "awsKinesis": { object (`AwsKinesis` ) }, "cloudStorage": { object (`CloudStorage` ) }, "azureEventHubs": { object (`AzureEventHubs` ) }, "awsMsk": { object (`AwsMsk` ) }, "confluentCloud": { object (`ConfluentCloud` ) } // End of list of possible types for union field `source`. }, "messageTransforms": [ { "enabled": boolean, "disabled": boolean, // Union field `transform` can be only one of the following: "javascriptUdf": { object (`JavaScriptUDF` ) }, "aiInference": { object (`AIInference` ) } // End of list of possible types for union field `transform`. } ], "tags": { string: string, ... } }, "updateMask": string }

{
 "topic": {
 "name": string,
 "labels": {
 string: string,
 ...
 },
 "messageStoragePolicy": {
 "allowedPersistenceRegions": [
 string
 ],
 "enforceInTransit": boolean
 },
 "kmsKeyName": string,
 "schemaSettings": {
 "schema": string,
 "encoding": enum (Encoding ),
 "firstRevisionId": string,
 "lastRevisionId": string
 },
 "satisfiesPzs": boolean,
 "messageRetentionDuration": string,
 "state": enum (State ),
 "ingestionDataSourceSettings": {
 "platformLogsSettings": {
 object (PlatformLogsSettings )
 },
 // Union field source can be only one of the following:
 "awsKinesis": {
 object (AwsKinesis )
 },
 "cloudStorage": {
 object (CloudStorage )
 },
 "azureEventHubs": {
 object (AzureEventHubs )
 },
 "awsMsk": {
 object (AwsMsk )
 },
 "confluentCloud": {
 object (ConfluentCloud )
 }
 // End of list of possible types for union field source.
 },
 "messageTransforms": [
 {
 "enabled": boolean,
 "disabled": boolean,
 // Union field transform can be only one of the following:
 "javascriptUdf": {
 object (JavaScriptUDF )
 },
 "aiInference": {
 object (AIInference )
 }
 // End of list of possible types for union field transform.
 }
 ],
 "tags": {
 string: string,
 ...
 }
 },
 "updateMask": string
}

Fields
`topic.labels`	`map (key: string, value: string)` Optional. See Creating and managing labels. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`topic.messageStoragePolicy`	`object (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.
`topic.kmsKeyName`	`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/`.
`topic.schemaSettings`	`object (SchemaSettings )` Optional. Settings for validating messages published against a schema.
`topic.satisfiesPzs`	`boolean` 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.
`topic.messageRetentionDuration`	`string (Duration format)` 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 `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. Cannot be more than 31 days or less than 10 minutes. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `"3.5s"`.
`topic.state`	`enum (State )` Output only. An output-only field indicating the state of the topic.
`topic.ingestionDataSourceSettings`	`object (IngestionDataSourceSettings )` Optional. Settings for ingestion from a data source into this topic.
`topic.messageTransforms[]`	`object (MessageTransform )` Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.
`topic.tags`	`map (key: string, value: string)` Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" See https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags for more information on using tags with Pub/Sub resources. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`updateMask`	`string (FieldMask format)` Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `updateMask` contains "messageStoragePolicy" but the `messageStoragePolicy` is not set in the `topic` provided above, then the updated value is determined by the policy configured at the project or organization level. This is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"`.

Response body

If successful, the response body contains an instance of Topic .

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Method: projects.topics.patch Stay organized with collections Save and categorize content based on your preferences.