Method: googleapis.pubsub.v1.projects.snapshots.patch

Updates an existing snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

Arguments

Parameters
name

string

Required. The name of the snapshot.
body

object (UpdateSnapshotRequest)

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 Snapshot.

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.snapshots.patch
    args:
        name: ...
        body:
            snapshot:
                expireTime: ...
                labels: ...
                name: ...
                topic: ...
            updateMask: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.pubsub.v1.projects.snapshots.patch",
      "args": {
        "name": "...",
        "body": {
          "snapshot": {
            "expireTime": "...",
            "labels": "...",
            "name": "...",
            "topic": "..."
          },
          "updateMask": "..."
        }
      },
      "result": "patchResult"
    }
  }
]