Method: googleapis.pubsub.v1.projects.subscriptions.modifyPushConfig

Modifies the PushConfig for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty PushConfig) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the PushConfig.

Arguments

Parameters
subscription

string

Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
body

object (ModifyPushConfigRequest)

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 will be empty.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- modifyPushConfig:
    call: googleapis.pubsub.v1.projects.subscriptions.modifyPushConfig
    args:
        subscription: ...
        body:
            pushConfig:
                attributes: ...
                oidcToken:
                    audience: ...
                    serviceAccountEmail: ...
                pushEndpoint: ...
    result: modifyPushConfigResult

JSON

[
  {
    "modifyPushConfig": {
      "call": "googleapis.pubsub.v1.projects.subscriptions.modifyPushConfig",
      "args": {
        "subscription": "...",
        "body": {
          "pushConfig": {
            "attributes": "...",
            "oidcToken": {
              "audience": "...",
              "serviceAccountEmail": "..."
            },
            "pushEndpoint": "..."
          }
        }
      },
      "result": "modifyPushConfigResult"
    }
  }
]