public sealed class NotificationConfig : IMessage<NotificationConfig>, IEquatable<NotificationConfig>, IDeepCloneable<NotificationConfig>, IBufferMessage, IMessageSpecification to configure notifications published to Cloud Pub/Sub.
Notifications will be published to the customer-provided topic using the
following PubsubMessage.attributes:
"eventType": one of the [EventType][google.storagetransfer.v1.NotificationConfig.EventType] values"payloadFormat": one of the [PayloadFormat][google.storagetransfer.v1.NotificationConfig.PayloadFormat] values"projectId": the [project_id][google.storagetransfer.v1.TransferOperation.project_id] of theTransferOperation"transferJobName": the [transfer_job_name][google.storagetransfer.v1.TransferOperation.transfer_job_name] of theTransferOperation"transferOperationName": the [name][google.storagetransfer.v1.TransferOperation.name] of theTransferOperation
The PubsubMessage.data will contain a
[TransferOperation][google.storagetransfer.v1.TransferOperation] resource
formatted according to the specified PayloadFormat.
Implements
IMessage<NotificationConfig>, IEquatable<NotificationConfig>, IDeepCloneable<NotificationConfig>, IBufferMessage, IMessageNamespace
Google.Cloud.StorageTransfer.V1Assembly
Google.Cloud.StorageTransfer.V1.dll
Constructors
NotificationConfig()
public NotificationConfig()NotificationConfig(NotificationConfig)
public NotificationConfig(NotificationConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
NotificationConfig |
Properties
EventTypes
public RepeatedField<NotificationConfig.Types.EventType> EventTypes { get; }Event types for which a notification is desired. If empty, send notifications for all event types.
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<NotificationConfig.Types.EventType> |
|
PayloadFormat
public NotificationConfig.Types.PayloadFormat PayloadFormat { get; set; }Required. The desired format of the notification message payloads.
| Property Value | |
|---|---|
| Type | Description |
NotificationConfig.Types.PayloadFormat |
|
PubsubTopic
public string PubsubTopic { get; set; }Required. The Topic.name of the Cloud Pub/Sub topic to which to publish
notifications. Must be of the format: projects/{project}/topics/{topic}.
Not matching this format will result in an
[INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT] error.
| Property Value | |
|---|---|
| Type | Description |
String |
|