NotificationConfig

Spezifikation zum Konfigurieren von Benachrichtigungen, die in Pub/Sub veröffentlicht werden. Benachrichtigungen werden mit der folgenden PubsubMessage.attributes im vom Kunden bereitgestellten Thema veröffentlicht:

  • "eventType": einer der EventType-Werte
  • "payloadFormat": einer der PayloadFormat-Werte
  • "projectId": der projectId der TransferOperation
  • "transferJobName": der transferJobName der TransferOperation
  • "transferOperationName": der name der TransferOperation

Die PubsubMessage.data enthält eine TransferOperation-Ressource, die gemäß dem angegebenen PayloadFormat formatiert ist.

JSON-Darstellung 
{
  "pubsubTopic": string,
  "eventTypes": [
    enum (EventType)
  ],
  "payloadFormat": enum (PayloadFormat)
}
Felder
pubsubTopic

string

Pflichtangabe. Die Topic.name des Pub/Sub-Themas, in dem Benachrichtigungen veröffentlicht werden sollen. Muss das Format projects/{project}/topics/{topic} haben. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben.
eventTypes[]

enum (EventType)

Ereignistypen, für die eine Benachrichtigung gewünscht wird. Wenn das Feld leer ist, werden Benachrichtigungen für alle Ereignistypen gesendet.
payloadFormat

enum (PayloadFormat)

Pflichtangabe. Das gewünschte Format der Nutzlasten der Benachrichtigungsnachrichten.

EventType

Enum zum Angeben von Ereignistypen, für die Benachrichtigungen veröffentlicht werden sollen.

In Zukunft werden möglicherweise weitere Ereignistypen hinzugefügt. Clients sollten entweder unbekannte Ereignistypen ignorieren oder explizit angeben, welche Ereignistypen akzeptiert werden.

Enums
EVENT_TYPE_UNSPECIFIED Ungültiger Wert, um einen Standardwert zu vermeiden.
TRANSFER_OPERATION_SUCCESS TransferOperation wurde mit dem Status SUCCESS abgeschlossen.
TRANSFER_OPERATION_FAILED TransferOperation wurde mit dem Status FAILED abgeschlossen.
TRANSFER_OPERATION_ABORTED TransferOperation wurde mit dem Status ABORTED abgeschlossen.

PayloadFormat

Aufzählung zum Angeben des Formats der Nutzlast einer Benachrichtigungsnachricht.

Enums
PAYLOAD_FORMAT_UNSPECIFIED Ungültiger Wert, um einen Standardwert zu vermeiden.
NONE Die Benachrichtigung enthält keine Nutzlast.
JSON TransferOperation ist als JSON-Antwort im Format „application/json“ formatiert.