Google Cloud BigQuery Analytics Hub V1 Client - Class PushConfig (1.5.0)
Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class PushConfig.
Configuration for a push delivery endpoint.
Generated from protobuf messagegoogle.cloud.bigquery.analyticshub.v1.PushConfig
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ oidc_token | PushConfig\OidcTokenOptional. If specified, Pub/Sub will generate and attach an OIDC JWT token as an |
↳ pubsub_wrapper | PushConfig\PubsubWrapperOptional. 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 | PushConfig\NoWrapperOptional. When set, the payload to the push endpoint is not wrapped. |
↳ push_endpoint | stringOptional. A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use |
↳ attributes | array|Google\Protobuf\Internal\MapFieldOptional. Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is |
getOidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWTtoken as anAuthorization header in the HTTP request for every pushedmessage.
| Returns | |
|---|---|
| Type | Description |
PushConfig\OidcToken|null | |
hasOidcToken
setOidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWTtoken as anAuthorization header in the HTTP request for every pushedmessage.
| Parameter | |
|---|---|
| Name | Description |
var | PushConfig\OidcToken |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPubsubWrapper
Optional. When set, the payload to the push endpoint is in the form ofthe JSON representation of a PubsubMessage(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
| Returns | |
|---|---|
| Type | Description |
PushConfig\PubsubWrapper|null | |
hasPubsubWrapper
setPubsubWrapper
Optional. When set, the payload to the push endpoint is in the form ofthe JSON representation of a PubsubMessage(https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
| Parameter | |
|---|---|
| Name | Description |
var | PushConfig\PubsubWrapper |
| Returns | |
|---|---|
| Type | Description |
$this | |
getNoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
| Returns | |
|---|---|
| Type | Description |
PushConfig\NoWrapper|null | |
hasNoWrapper
setNoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
| Parameter | |
|---|---|
| Name | Description |
var | PushConfig\NoWrapper |
| Returns | |
|---|---|
| Type | Description |
$this | |
getPushEndpoint
Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might usehttps://example.com/push.
| Returns | |
|---|---|
| Type | Description |
string | |
setPushEndpoint
Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might usehttps://example.com/push.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAttributes
Optional. Endpoint configuration attributes that can be used to controldifferent aspects of the message delivery.
The only currently supported attribute isx-goog-version, which you canuse to change the format of the pushed message. This attributeindicates the version of the data expected by the endpoint. Thiscontrols the shape of the pushed message (i.e., its fields and metadata).If not present during theCreateSubscription call, it will default tothe version of the Pub/Sub API used to make such call. If not present in aModifyPushConfig call, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription wascreated without this attribute.The only supported values for thex-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: 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
Optional. Endpoint configuration attributes that can be used to controldifferent aspects of the message delivery.
The only currently supported attribute isx-goog-version, which you canuse to change the format of the pushed message. This attributeindicates the version of the data expected by the endpoint. Thiscontrols the shape of the pushed message (i.e., its fields and metadata).If not present during theCreateSubscription call, it will default tothe version of the Pub/Sub API used to make such call. If not present in aModifyPushConfig call, its value will not be changed.GetSubscriptioncalls will always return a valid version, even if the subscription wascreated without this attribute.The only supported values for thex-goog-version attribute are:
v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.v1orv1beta2: 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 | |
getAuthenticationMethod
| Returns | |
|---|---|
| Type | Description |
string | |
getWrapper
| Returns | |
|---|---|
| Type | Description |
string | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-08 UTC.