REST-Ressource: projects.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,
  "destinationDatasetId": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "dataRefreshWindowDays": number,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum(TransferState),
  "userId": string,
  "datasetRegion": string,
  "partnerToken": string,
  "partnerConnectionInfo": {
    object
  }
}
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 „configId“ zusammen mit der ID für „projectId“ und der Region generiert. Wenn keine configId angegeben ist, wird dafür normalerweise eine uuid generiert, auch wenn dies weder garantiert noch erforderlich ist.

destinationDatasetId

string

enthält die ID des BigQuery-Ziel-Datasets.
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 Zeiten haben das UTC-Format. 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: Der Detaillierungsgrad sollte mindestens acht Stunden oder weniger betragen.

dataRefreshWindowDays

number

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.

Zeitstempel im Format RFC3339 UTC "Zulu" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
nextRunTime

string (Timestamp format)

Nur Ausgabe enthält den nächsten Ausführungszeitpunkt der Datenübertragung.

Zeitstempel im Format RFC3339 UTC "Zulu" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
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.

partnerToken

string

Eindeutige Kennung zur Identifizierung einer Übertragungseinrichtung, die von externen Partnern gespeichert wird. Das Token ist für DTS intransparent und kann nur vom Partner interpretiert werden. Die Datenquelle des Partners sollte eine Zuordnung zwischen der Konfigurations-ID und dem Token erstellen, um zu prüfen, ob die Übertragungskonfiguration/-ausführung zulässig ist.

partnerConnectionInfo

object (Struct format)

Übertragungseinstellungen, die von Partnerdatenquellen verwaltet werden. Das Feld wird als Schlüssel/Wert-Paar gespeichert und nur für die Anzeige der DTS-UI verwendet. Dieses Feld soll aus zwei Gründen nicht zusammen mit dem Feld „params“ gespeichert werden: – Die Verbindungsinformationen werden vom Partner bereitgestellt und können anders als beim unveränderlichen Parameter nicht in der DTS-UI bearbeitet werden. Es wäre verwirrend, einen weiteren booleschen Parameter zu DataSourceParameter hinzuzufügen, um sie voneinander zu unterscheiden. – Die Verbindungsinformationen können beliebige Schlüssel/Wert-Paare sein. Wenn sie zu „params“-Feldern hinzugefügt werden, muss der Partner sie in der Definition der Datenquelle definieren. Es ist besser und einfacher für Partner, wenn dies vermieden wird.

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

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