PushConfig
class PushConfig extends Message
Configuration for a push delivery endpoint.
Protobuf type Google\Pubsub\V1\PushConfig
Methods
No description
A URL locating the endpoint to which messages should be pushed.
A URL locating the endpoint to which messages should be pushed.
Endpoint configuration attributes.
Endpoint configuration attributes.
Details
at line 47
__construct()
at line 59
string
getPushEndpoint()
A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use "https://example.com/push".
Generated from protobuf field string push_endpoint = 1;
at line 71
setPushEndpoint(string $var)
A URL locating the endpoint to which messages should be pushed.
For example, a Webhook endpoint might use "https://example.com/push".
Generated from protobuf field string push_endpoint = 1;
at line 98
RepeatedField
getAttributes()
Endpoint configuration attributes.
Every endpoint has a set of API supported attributes that can be used to
control different aspects of the message delivery.
The 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).
The endpoint version is based on the version of the Pub/Sub API.
If not present during the CreateSubscription call, it will default to
the version of the API used to make such call. If not present during 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 possible values for this 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.
Generated from protobuf field map<string, string> attributes = 2;
at line 124
setAttributes(array|RepeatedField $var)
Endpoint configuration attributes.
Every endpoint has a set of API supported attributes that can be used to
control different aspects of the message delivery.
The 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).
The endpoint version is based on the version of the Pub/Sub API.
If not present during the CreateSubscription call, it will default to
the version of the API used to make such call. If not present during 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 possible values for this 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.
Generated from protobuf field map<string, string> attributes = 2;