Updates an existing topic. Note that certain properties of a topic are not modifiable.
Arguments
Parameters
name
string
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"
.
body
object ( UpdateTopicRequest
)
Required.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response contains an instance of Topic
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation .
YAML
- patch : call : googleapis.pubsub.v1.projects.topics.patch args : name : ... body : topic : kmsKeyName : ... labels : ... messageRetentionDuration : ... messageStoragePolicy : allowedPersistenceRegions : ... name : ... satisfiesPzs : ... schemaSettings : encoding : ... schema : ... updateMask : ... result : patchResult
JSON
[ { "patch" : { "call" : "googleapis.pubsub.v1.projects.topics.patch" , "args" : { "name" : "..." , "body" : { "topic" : { "kmsKeyName" : "..." , "labels" : "..." , "messageRetentionDuration" : "..." , "messageStoragePolicy" : { "allowedPersistenceRegions" : "..." }, "name" : "..." , "satisfiesPzs" : "..." , "schemaSettings" : { "encoding" : "..." , "schema" : "..." } }, "updateMask" : "..." } }, "result" : "patchResult" } } ]
