REST-Ressource: projects.locations.dataSources

Ressource: DataSource

Stellt die Metadaten einer Datenquelle dar. Metadaten reichen aus, um die UI zu rendern und korrekte OAuth-Tokens anzufordern.

JSON-Darstellung 

{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum(TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": number,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object(DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum(AuthorizationType),
  "dataRefreshType": enum(DataRefreshType),
  "defaultDataRefreshWindowDays": number,
  "manualRunsDisabled": boolean,
  "minimumScheduleInterval": string,
  "partnerLegalName": string,
  "redirectUrl": string
}
Felder
name

string

Nur Ausgabe. Name der Datenquellenressource.

dataSourceId

string

Die ID der Datenquelle.
displayName

string

Der nutzerfreundliche Name der Datenquelle.
description

string

Der String mit der nutzerfreundlichen Beschreibung der Datenquelle.
clientId

string

Die Client-ID der Datenquelle, die zum Empfangen des Aktualisierungstokens verwendet werden soll.
scopes[]

string

Die API-Auth-Bereiche, für die Aktualisierungstokens abgerufen werden müssen. Dies sind Bereiche wie https://www.googleapis.com/auth/bigquery, die von einer Datenquelle zur Vorbereitung von Daten und deren Aufnahme in BigQuery benötigt werden.

transferType
(deprecated)

enum(TransferType)

Verworfen. Dieses Feld hat keine Auswirkung.
supportsMultipleTransfers
(deprecated)

boolean

Verworfen. Dieses Feld hat keine Auswirkung.
updateDeadlineSeconds

number

Die Anzahl der Sekunden, die auf eine Aktualisierung von der Datenquelle zu warten ist, bevor der Data Transfer Service die Übertragung als fehlgeschlagen markiert.
defaultSchedule

string

Der Standardzeitplan für die Datenübertragung. Beispiele für gültige Zeitpläne sind 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 und first sunday of quarter 00:00.

supportsCustomSchedule

boolean

Gibt an, ob die Datenquelle einen benutzerdefinierten Zeitplan unterstützt oder mit dem Standardzeitplan arbeitet. Bei Einstellung auf true kann der Nutzer den Standardzeitplan überschreiben.

parameters[]

object(DataSourceParameter)

Die Parameter der Datenquelle.
helpUrl

string

Die URL des Hilfedokuments für diese Datenquelle.
authorizationType

enum(AuthorizationType)

Zeigt den Autorisierungstyp an.
dataRefreshType

enum(DataRefreshType)

Gibt an, ob die Datenquelle die automatische Datenaktualisierung für die letzten Tage unterstützt und wie diese unterstützt wird. Bei einigen Datenquellen sind die Daten möglicherweise erst einige Tage später vollständig. Daher ist zu empfehlen, die Daten automatisch zu aktualisieren.

defaultDataRefreshWindowDays

number

Das Standardfenster für die Datenaktualisierung in Tagen. Nur sinnvoll, wenn dataRefreshType = SLIDING_WINDOW.

manualRunsDisabled

boolean

Deaktiviert den Backfill und die manuelle Ausführungsplanung für die Datenquelle.
minimumScheduleInterval

string (Duration format)

Das Mindestintervall, das der Planer zur Planung von Ausführungen verwenden kann.

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

string

Weiterleitungs-URL zum Abschließen der Einrichtung der Übertragungskonfiguration für Datenquellen von Drittanbietern.

Methoden

checkValidCreds

 Gibt "true" zurück, wenn gültige Anmeldedaten für die angegebene Datenquelle und den anfordernden Nutzer vorhanden sind.

get

 Ruft eine unterstützte Datenquelle ab und gibt ihre Einstellungen zurück, die für die UI-Erstellung verwendet werden können.

list

 Listet unterstützte Datenquellen auf und gibt ihre Einstellungen zurück, die für die UI-Erstellung verwendet werden können.