Cloud PubSub V1 Client - Class PushConfig (1.48.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class PushConfig.

Configuration for a push delivery endpoint.

Generated from protobuf message google.pubsub.v1.PushConfig

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ push_endpoint`	`string` A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use `https://example.com/push`.
`↳ attributes`	`array\|Google\Protobuf\Internal\MapField` Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is `x-goog-version`, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the `CreateSubscription` call, it will default to the version of the Pub/Sub API used to make such call. If not present in a `ModifyPushConfig` call, its value will not be changed. `GetSubscription` calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the `x-goog-version` attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For example: `attributes { "x-goog-version": "v1" }`
`↳ oidc_token`	`Google\Cloud\PubSub\V1\PushConfig\OidcToken` If specified, Pub/Sub will generate and attach an OIDC JWT token as an `Authorization` header in the HTTP request for every pushed message.
`↳ pubsub_wrapper`	`Google\Cloud\PubSub\V1\PushConfig\PubsubWrapper` When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
`↳ no_wrapper`	`Google\Cloud\PubSub\V1\PushConfig\NoWrapper` When set, the payload to the push endpoint is not wrapped.

getPushEndpoint

A URL locating the endpoint to which messages should be pushed.

For example, a Webhook endpoint might use https://example.com/push.

Returns
Type	Description
`string`

setPushEndpoint

A URL locating the endpoint to which messages should be pushed.

For example, a Webhook endpoint might use https://example.com/push.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAttributes

Endpoint configuration attributes that can be used to control different aspects of the message delivery.

The only currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The only supported values for the x-goog-version attribute are:

v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.
v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setAttributes

Endpoint configuration attributes that can be used to control different aspects of the message delivery.

v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.
v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API. For example: attributes { "x-goog-version": "v1" }

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getOidcToken

If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

Returns
Type	Description
`Google\Cloud\PubSub\V1\PushConfig\OidcToken\|null`

hasOidcToken

setOidcToken

If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

Parameter
Name	Description
`var`	`Google\Cloud\PubSub\V1\PushConfig\OidcToken`

Returns
Type	Description
`$this`

getPubsubWrapper

When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

Returns
Type	Description
`Google\Cloud\PubSub\V1\PushConfig\PubsubWrapper\|null`

hasPubsubWrapper

setPubsubWrapper

When set, the payload to the push endpoint is in the form of the JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).

Parameter
Name	Description
`var`	`Google\Cloud\PubSub\V1\PushConfig\PubsubWrapper`

Returns
Type	Description
`$this`

getNoWrapper

When set, the payload to the push endpoint is not wrapped.

Returns
Type	Description
`Google\Cloud\PubSub\V1\PushConfig\NoWrapper\|null`

hasNoWrapper

setNoWrapper

When set, the payload to the push endpoint is not wrapped.

Parameter
Name	Description
`var`	`Google\Cloud\PubSub\V1\PushConfig\NoWrapper`

Returns
Type	Description
`$this`

getAuthenticationMethod

Returns
Type	Description
`string`

getWrapper

Returns
Type	Description
`string`