NotificationConfig

Specification 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 values
  • "payloadFormat": one of the PayloadFormat values
  • "projectId": the projectId of the TransferOperation
  • "transferJobName": the transferJobName of the TransferOperation
  • "transferOperationName": the name of the TransferOperation

The PubsubMessage.data will contain a TransferOperation resource formatted according to the specified PayloadFormat.

JSON representation
{
  "pubsubTopic": string,
  "eventTypes": [
    enum (EventType)
  ],
  "payloadFormat": enum (PayloadFormat)
}
Fields
pubsubTopic

string

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 error.

eventTypes[]

enum (EventType)

Event types for which a notification is desired. If empty, send notifications for all event types.

payloadFormat

enum (PayloadFormat)

Required. The desired format of the notification message payloads.

EventType

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.

Enums
EVENT_TYPE_UNSPECIFIED Illegal value, to avoid allowing a default.
TRANSFER_OPERATION_SUCCESS TransferOperation completed with status SUCCESS.
TRANSFER_OPERATION_FAILED TransferOperation completed with status FAILED.
TRANSFER_OPERATION_ABORTED TransferOperation completed with status ABORTED.

PayloadFormat

Enum for specifying the format of a notification message's payload.

Enums
PAYLOAD_FORMAT_UNSPECIFIED Illegal value, to avoid allowing a default.
NONE No payload is included with the notification.
JSON TransferOperation is formatted as a JSON response, in application/json.