REST-Ressource: projects.locations.dataSourceDefinitions

Ressource: DataSourceDefinition

Stellt die Datenquellendefinition dar.

JSON-Darstellung 

{
  "name": string,
  "dataSource": {
    object(DataSource)
  },
  "transferRunPubsubTopic": string,
  "runTimeOffset": string,
  "supportEmail": string,
  "serviceAccount": string,
  "disabled": boolean,
  "transferConfigPubsubTopic": string,
  "supportedLocationIds": [
    string
  ]
}
Felder
name

string

Der Ressourcenname der Datenquellendefinition. Namen von Datenquellendefinitionen haben das Format projects/{projectId}/locations/{location}/dataSourceDefinitions/{dataSourceId}.

dataSource

object(DataSource)

Datenquellenmetadaten.
transferRunPubsubTopic

string

Das Pub/Sub-Thema, das beim Erstellen einer Übertragungsausführung zum Senden einer Nachricht zu verwenden ist. Sie können dieses Thema und transferConfigPubsubTopic auf ein benutzerdefiniertes Thema festlegen. Standardmäßig werden beide Themen automatisch generiert, wenn beim Erstellen der Definition kein Thema ausgewählt wird. Wird jedoch ein Thema manuell festgelegt, muss das andere Thema auch manuell festgelegt werden. Der einzige Unterschied besteht darin, dass transferRunPubsubTopic ein nicht leeres Pub/Sub-Thema sein muss, während für transferConfigPubsubTopic ein leerer Wert festgelegt werden kann. Die Kommentare zu „{location}“ für transferConfigPubsubTopic gelten auch hier.

runTimeOffset

string (Duration format)

Die Dauer, die scheduleTime hinzugefügt werden muss, um runTime beim Planen des Jobs zu berechnen. Gilt nur für automatisch geplante Übertragungsausführungen. Wird verwendet, um für eine Datenquelle eine vorzeitige Ausführung zu starten, die eine kontinuierliche Datenaktualisierung unterstützt, um unbekannte Zeitzonenverschiebungen auszugleichen. Verwenden Sie eine negative Zahl, um eine späte Ausführung für Datenquellen zu starten, die keine kontinuierliche Datenaktualisierung unterstützen.

Dauer in Sekunden mit bis zu neun Nachkommastellen und einem „s“ an letzter Stelle. Beispiel: "3.5s".
supportEmail

string

Die Support-E-Mail-Adresse der Marke des OAuth-Clients, die die Daten des Zustimmungsbildschirms enthält.
serviceAccount

string

Wenn ein Dienstkonto angegeben ist, gibt BigQuery das erstellte Dataset für das angegebene Dienstkonto frei. Außerdem ist dieses Dienstkonto berechtigt, Statusaktualisierungen und Nachrichten-Logging für Datenübertragungsausführungen mit der entsprechenden dataSourceId durchzuführen.

disabled

boolean

Ob die Datenquelle deaktiviert ist. Bei Einstellung auf "true" ist "dataSource" nicht sichtbar. Von der API werden außerdem keine Datenübertragungskonfigurationen und/oder -ausführungen mehr zurückgeben, die der Datenquelle zugeordnet sind. Diese Einstellung hat Vorrang vor whitelisted_project_ids.

transferConfigPubsubTopic

string

Das Pub/Sub-Thema, das zum Übertragen einer Nachricht für die Übertragungskonfiguration verwendet werden soll. Wenn das Feld leer ist, wird keine Nachricht gesendet. Sowohl dieses Thema als auch transferRunPubsubTopic werden automatisch generiert, wenn beim Erstellen der Definition kein Thema ausgewählt wird. Geben Sie transferConfigPubsubTopic an, wenn vom Nutzer ein Thema für transferRunPubsubTopic festgelegt wurde. Andernfalls wird das Feld leer gelassen. Wenn „{location}“ im Wert enthalten ist, bedeutet das, dass die Datenquelle Nachrichten für Datasets in verschiedenen Regionen separat verarbeiten soll. {location} wird durch den tatsächlichen Dataset-Standort ersetzt und dient als tatsächlicher Themenname. Beispielsweise kann projects/connector/topics/scheduler-{location} zu projects/connector/topics/scheduler-us werden. Wenn „{location}“ nicht gefunden wird, verwenden wir den Eingabewert als Themennamen.

supportedLocationIds[]

string

Mit unterstützten location_ids wird festgelegt, an welchen Standorten Pub/Sub-Themen erstellt werden müssen. Wenn benutzerdefinierte Pub/Sub-Themen verwendet werden und {location} enthalten ist, werden location_ids für die Validierung der Themen verwendet. Dabei wird {location} durch den jeweiligen Standort aus der Liste ersetzt. Gültige Werte sind im Feld „locationId“ der Antwort von GET https://bigquerydatatransfer.googleapis.com/v1/{name=projects/*}/locations enthalten. Wenn die Datenquelle alle verfügbaren Regionen unterstützen muss, kann für supportedLocationIds außerdem der Wert „global“ (ein einzelnes Stringelement) festgelegt werden. Wenn „global“ angegeben ist, ist Folgendes zu beachten: 1) Die Datenquellenimplementierung soll die Daten in der richtigen Region des Ziel-Datasets bereitstellen. 2) Entwickler von Datenquellen müssen sich der Auswirkungen Unterstützung einer „globalen Region“ bewusst sein (z. B. Netzwerklatenzlatenz oder potenzielle Kosten für regionsübergreifenden Traffic usw.).

Methoden

create

 Erstellt eine Datenquellendefinition.

delete

 Dadurch wird die Definition der Datenquelle gelöscht. Alle mit dieser Datenquellendefinition zusammenhängenden Übertragungskonfigurationen (falls vorhanden) müssen vom Nutzer zuerst in ALLEN REGIONEN gelöscht werden. Erst dann kann die Datenquellendefinition gelöscht werden.

get

 Ruft eine vorhandene Datenquellendefinition ab.

list

 Listet unterstützte Datenquellendefinitionen auf.

patch

 Aktualisiert eine vorhandene Datenquellendefinition.