REST-Ressource: projects.locations.transferConfigs

Ressource: TransferConfig

Stellt eine Datenübertragungskonfiguration dar. Eine Übertragungskonfiguration enthält alle Metadaten, die für eine Datenübertragung benötigt werden. Beispielsweise gibt destinationDatasetId an, wo Daten gespeichert werden sollen. Beim Erstellen einer neuen Übertragungskonfiguration wird die angegebene destinationDatasetId bei Bedarf erstellt und für das entsprechende Datenquellen-Dienstkonto freigegeben.

JSON-Darstellung 

{
  "name": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "scheduleOptions": {
    object (ScheduleOptions)
  },
  "dataRefreshWindowDays": integer,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum (TransferState),
  "userId": string,
  "datasetRegion": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
Felder
name

string

Der Ressourcenname der Übertragungskonfiguration; Namen von Übertragungskonfigurationen haben das Format projects/{projectId}/locations/{region}/transferConfigs/{configId}. Der Name wird automatisch anhand der in CreateTransferConfigRequest angegebenen ID für „config_id“ zusammen mit der ID für „project_id“ und der Region generiert. Wenn keine configId angegeben ist, wird normalerweise eine UUID für configId generiert, auch wenn dies weder garantiert noch erforderlich ist.
displayName

string

Der benutzerdefinierte Anzeigename für die Datenübertragung.
dataSourceId

string

Die ID der Datenquelle; Kann nicht geändert werden, nachdem die Datenübertragung erstellt wurde.
params

object (Struct format)

Datenübertragungsspezifische Parameter.
schedule

string

Der Zeitplan für die Datenübertragung; wenn die Datenquelle keinen benutzerdefinierten Zeitplan unterstützt, sollte dieses Feld leer sein. Wenn es leer ist, wird der Standardwert für die Datenquelle verwendet. Die angegebenen Zeitpunkte werden in UTC angegeben. Beispiele für ein gültiges Format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 und first sunday of quarter 00:00. Weitere Informationen zum Format finden Sie unter https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format. HINWEIS: Die Granularität sollte mindestens acht Stunden oder weniger betragen.
scheduleOptions

object (ScheduleOptions)

Optionen zum Anpassen des Zeitplans für die Datenübertragung.
dataRefreshWindowDays

integer

Die Anzahl der Tage, auf die zum automatischen Aktualisieren der Daten zurückgegriffen werden soll. Bei dataRefreshWindowDays = 10 nimmt BigQuery beispielsweise jeden Tag Daten über den Zeitraum [heute-10, heute-1] noch einmal auf, und nicht nur für [heute-1]. Nur gültig, wenn die Datenquelle die Funktion unterstützt. Legen Sie den Wert auf 0 fest, um den Standardwert zu verwenden.
disabled

boolean

Ob diese Konfiguration deaktiviert ist; Wenn dieser Wert auf "true" gesetzt ist, werden für eine angegebene Übertragung keine Ausführungen geplant.
updateTime

string (Timestamp format)

Nur Ausgabe. enthält den Änderungszeitpunkt der Datenübertragung. Wird vom Server bei der Eingabe ignoriert.
nextRunTime

string (Timestamp format)

Nur Ausgabe. Der nächste Ausführungszeitpunkt der Datenübertragung.
state

enum (TransferState)

Nur Ausgabe. enthält den Status der zuletzt aktualisierten Übertragungsausführung.
userId

string (int64 format)

Veraltet. enthält die eindeutige ID des Nutzers, in dessen Namen die Daten übertragen werden.
datasetRegion

string

Nur Ausgabe. enthält die Region, in der sich das BigQuery-Dataset befindet.
notificationPubsubTopic

string

Pub/Sub-Thema, an das Benachrichtigungen gesendet werden, nachdem die mit dieser Übertragungskonfiguration verknüpften Übertragungsausführungen abgeschlossen wurden.
emailPreferences

object (EmailPreferences)

E-Mail-Benachrichtigungen werden gemäß diesen Einstellungen an die E-Mail-Adresse des Nutzers gesendet, der Eigentümer dieser Übertragungskonfiguration ist.
destinationDatasetId

string

enthält die ID des BigQuery-Ziel-Datasets.

ScheduleOptions

Optionen zum Anpassen des Zeitplans für die Datenübertragung.

JSON-Darstellung 

{
  "disableAutoScheduling": boolean,
  "startTime": string,
  "endTime": string
}
Felder
disableAutoScheduling

boolean

Bei Einstellung auf „true“ wird das automatische Planen von Datenübertragungsausführungen für diese Konfiguration deaktiviert. Die Ausführungen können mit der transferConfigs.startManualRuns API auf Ad-hoc-Basis gestartet werden. Wenn das automatische Planen deaktiviert ist, wird das Feld „TransferConfig.schedule“ ignoriert.
startTime

string (Timestamp format)

Gibt den Zeitpunkt an, ab dem Übertragungsausführungen geplant werden sollen. Die erste Ausführung wird gemäß eines Wiederholungsmusters, das im Planungsstring definiert ist, für den Zeitpunkt des Beginns oder für einen Zeitpunkt nach diesem geplant. Der Zeitpunkt des Beginns kann jederzeit geändert werden. Durch diese Option wird der Zeitraum, in dem eine Datenübertragung manuell ausgelöst werden kann, nicht eingeschränkt.
endTime

string (Timestamp format)

Definiert den Zeitpunkt, ab dem keine Übertragungsausführungen mehr geplant werden sollen. Eine Übertragungsausführung kann weder zum Zeitpunkt des Endes noch danach geplant werden. Der Zeitpunkt des Endes kann jederzeit geändert werden. Durch diese Option wird der Zeitraum, in dem eine Datenübertragung manuell ausgelöst werden kann, nicht eingeschränkt.

Methoden

create

 Erstellt eine neue Datenübertragungskonfiguration.

delete

 Löscht eine Datenübertragungskonfiguration, einschließlich zugehöriger Übertragungsausführungen und Protokolle.

get

 Gibt Informationen zu einer Datenübertragungskonfiguration zurück.

list

 Gibt Informationen zu allen Datenübertragungen im Projekt zurück.

patch

 Aktualisiert eine Datenübertragungskonfiguration.

scheduleRuns
(deprecated)

 Erstellt Übertragungsausführungen für einen Zeitraum [start_time, end_time].

startManualRuns

 Startet manuelle Übertragungsausführungen, die jetzt ausgeführt werden sollen, wobei schedule_time der aktuellen Uhrzeit entspricht.