Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class NotificationConfig.
Specification to configure notifications published to Pub/Sub.
Notifications are published to the customer-provided topic using the
following PubsubMessage.attributes
:
-
"eventType": one of the EventType values -
"payloadFormat": one of the PayloadFormat values -
"projectId": the project_id of theTransferOperation -
"transferJobName": the transfer_job_name of theTransferOperation -
"transferOperationName": the name of theTransferOperationThePubsubMessage.datacontains a TransferOperation resource formatted according to the specifiedPayloadFormat.
Generated from protobuf message google.storagetransfer.v1.NotificationConfig
Namespace
Google \ Cloud \ StorageTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ pubsub_topic
string
Required. The Topic.name
of the Pub/Sub topic to which to publish notifications. Must be of the format: projects/{project}/topics/{topic}
. Not matching this format results in an INVALID_ARGUMENT
error.
↳ event_types
array
Event types for which a notification is desired. If empty, send notifications for all event types.
↳ payload_format
int
Required. The desired format of the notification message payloads.
getPubsubTopic
Required. The Topic.name
of the Pub/Sub topic to which to publish
notifications. Must be of the format: projects/{project}/topics/{topic}
.
Not matching this format results in an INVALID_ARGUMENT error.
string
setPubsubTopic
Required. The Topic.name
of the Pub/Sub topic to which to publish
notifications. Must be of the format: projects/{project}/topics/{topic}
.
Not matching this format results in an INVALID_ARGUMENT error.
var
string
$this
getEventTypes
Event types for which a notification is desired. If empty, send notifications for all event types.
setEventTypes
Event types for which a notification is desired. If empty, send notifications for all event types.
var
int[]
$this
getPayloadFormat
Required. The desired format of the notification message payloads.
setPayloadFormat
Required. The desired format of the notification message payloads.
$this
