Reference documentation and code samples for the Google Apps Events Subscriptions V1beta Client class NotificationEndpoint.
The endpoint where the subscription delivers events.
Generated from protobuf message google.apps.events.subscriptions.v1beta.NotificationEndpoint
Namespace
Google \ Apps \ Events \ Subscriptions \ V1betaMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ pubsub_topic |
string
Immutable. The Pub/Sub topic that receives events for the subscription. Format: |
getPubsubTopic
Immutable. The Pub/Sub topic that receives events for the subscription.
Format: projects/{project}/topics/{topic}
You must create the topic in the same Google Cloud project where
you create this subscription.
Note: The Workspace Events API uses ordering
keys for the benefit of
sequential events. If the Cloud Pub/Sub topic has a message storage
policy
configured to exclude the nearest Google Cloud region, publishing events
with ordering keys will fail.
When the topic receives events, the events are encoded as Pub/Sub
messages. For details, see the Google Cloud Pub/Sub Protocol Binding for
CloudEvents.
Returns | |
---|---|
Type | Description |
string |
hasPubsubTopic
setPubsubTopic
Immutable. The Pub/Sub topic that receives events for the subscription.
Format: projects/{project}/topics/{topic}
You must create the topic in the same Google Cloud project where
you create this subscription.
Note: The Workspace Events API uses ordering
keys for the benefit of
sequential events. If the Cloud Pub/Sub topic has a message storage
policy
configured to exclude the nearest Google Cloud region, publishing events
with ordering keys will fail.
When the topic receives events, the events are encoded as Pub/Sub
messages. For details, see the Google Cloud Pub/Sub Protocol Binding for
CloudEvents.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getEndpoint
Returns | |
---|---|
Type | Description |
string |