NotificationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Specification to configure notifications published to Pub/Sub.
Notifications are published to the customer-provided topic using the
following PubsubMessage.attributes
:
"eventType"
: one of theEventType][google.storagetransfer.v1.NotificationConfig.EventType]
values"payloadFormat"
: one of thePayloadFormat][google.storagetransfer.v1.NotificationConfig.PayloadFormat]
values"projectId"
: theproject_id][google.storagetransfer.v1.TransferOperation.project_id]
of theTransferOperation
"transferJobName"
: thetransfer_job_name][google.storagetransfer.v1.TransferOperation.transfer_job_name]
of theTransferOperation
"transferOperationName"
: thename][google.storagetransfer.v1.TransferOperation.name]
of theTransferOperation
The PubsubMessage.data
contains a
TransferOperation][google.storagetransfer.v1.TransferOperation]
resource formatted according to the specified PayloadFormat
.
Attributes
Name | Description |
pubsub_topic |
str
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][google.rpc.Code.INVALID_ARGUMENT]` error. |
event_types |
Sequence[google.cloud.storage_transfer_v1.types.NotificationConfig.EventType]
Event types for which a notification is desired. If empty, send notifications for all event types. |
payload_format |
google.cloud.storage_transfer_v1.types.NotificationConfig.PayloadFormat
Required. The desired format of the notification message payloads. |
Inheritance
builtins.object > proto.message.Message > NotificationConfigClasses
EventType
EventType(value)
Enum for specifying event types for which notifications are to be published.
Additional event types may be added in the future. Clients should either safely ignore unrecognized event types or explicitly specify which event types they are prepared to accept.
PayloadFormat
PayloadFormat(value)
Enum for specifying the format of a notification message's payload.