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 message google.cloud.bigquery.analyticshub.v1.PushConfig
Namespace
Google \ Cloud \ BigQuery \ AnalyticsHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ oidc_token
PushConfig\OidcToken
Optional. 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
PushConfig\PubsubWrapper
Optional. 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
↳ push_endpoint
string
Optional. 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
Optional. 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" }
getOidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization
header in the HTTP request for every pushed
message.
hasOidcToken
setOidcToken
Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
token as an Authorization
header in the HTTP request for every pushed
message.
$this
getPubsubWrapper
Optional. 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 ).
hasPubsubWrapper
setPubsubWrapper
Optional. 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 ).
$this
getNoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
hasNoWrapper
setNoWrapper
Optional. When set, the payload to the push endpoint is not wrapped.
$this
getPushEndpoint
Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push
.
string
setPushEndpoint
Optional. A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use https://example.com/push
.
var
string
$this
getAttributes
Optional. 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. -
v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. For example:attributes { "x-goog-version": "v1" }
setAttributes
Optional. 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. -
v1orv1beta2: uses the push format defined in the v1 Pub/Sub API. For example:attributes { "x-goog-version": "v1" }
$this
getAuthenticationMethod
string
getWrapper
string
