REST-Ressource: projects.dataSources

Ressource: DataSource
Methoden

Ressource: DataSource

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

JSON-Darstellung

JSON-Darstellung
{ "name": string, "dataSourceId": string, "displayName": string, "description": string, "clientId": string, "scopes": [ string ], "transferType": enum (`TransferType`), "supportsMultipleTransfers": boolean, "updateDeadlineSeconds": integer, "defaultSchedule": string, "supportsCustomSchedule": boolean, "parameters": [ { object (`DataSourceParameter`) } ], "helpUrl": string, "authorizationType": enum (`AuthorizationType`), "dataRefreshType": enum (`DataRefreshType`), "defaultDataRefreshWindowDays": integer, "manualRunsDisabled": boolean, "minimumScheduleInterval": string }


{
  "name": string,
  "dataSourceId": string,
  "displayName": string,
  "description": string,
  "clientId": string,
  "scopes": [
    string
  ],
  "transferType": enum (TransferType),
  "supportsMultipleTransfers": boolean,
  "updateDeadlineSeconds": integer,
  "defaultSchedule": string,
  "supportsCustomSchedule": boolean,
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],
  "helpUrl": string,
  "authorizationType": enum (AuthorizationType),
  "dataRefreshType": enum (DataRefreshType),
  "defaultDataRefreshWindowDays": integer,
  "manualRunsDisabled": boolean,
  "minimumScheduleInterval": 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)` Dieses Element wurde verworfen. Verworfen. Dieses Feld hat keine Auswirkungen.
`supportsMultipleTransfers (deprecated)`	`boolean` Dieses Element wurde verworfen. Verworfen. Dieses Feld hat keine Auswirkungen.
`updateDeadlineSeconds`	`integer` 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`	`integer` Das Standardfenster für die Datenaktualisierung in Tagen. Dies ist 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"`.

TransferType

VERWORFEN. Stellt den Datenübertragungstyp dar.

Enums
`TRANSFER_TYPE_UNSPECIFIED`	Ein ungültiger oder unbekannter Platzhalter für den Übertragungstyp.
`BATCH`	Eine Batchdatenübertragung.
`STREAMING`	Eine Streamingdatenübertragung. Mehrere Übertragungskonfigurationen pro Projekt werden von der Streamingdatenquelle derzeit nicht unterstützt.

DataSourceParameter

Stellt den Parameter einer Datenquelle mit Validierungsregeln bereit, damit Parameter in der UI gerendert werden können. Diese Parameter werden von unterstützten Datenquellen bereitgestellt und enthalten alle erforderlichen Informationen für das Rendering und die Validierung. So kann jede Person, die diese API verwendet, selbst entscheiden, ob die allgemeine UI oder benutzerdefinierte, datenquellenspezifische Varianten generiert werden.

JSON-Darstellung

JSON-Darstellung
{ "paramId": string, "displayName": string, "description": string, "type": enum (`Type`), "required": boolean, "repeated": boolean, "validationRegex": string, "allowedValues": [ string ], "minValue": number, "maxValue": number, "fields": [ { object (`DataSourceParameter`) } ], "validationDescription": string, "validationHelpUrl": string, "immutable": boolean, "recurse": boolean, "deprecated": boolean }


{
  "paramId": string,
  "displayName": string,
  "description": string,
  "type": enum (Type),
  "required": boolean,
  "repeated": boolean,
  "validationRegex": string,
  "allowedValues": [
    string
  ],
  "minValue": number,
  "maxValue": number,
  "fields": [
    {
      object (DataSourceParameter)
    }
  ],
  "validationDescription": string,
  "validationHelpUrl": string,
  "immutable": boolean,
  "recurse": boolean,
  "deprecated": boolean
}

Felder
`paramId`	`string` Die Kennzeichnung des Parameters.
`displayName`	`string` Der Anzeigename des Parameters in der Benutzeroberfläche.
`description`	`string` Die Beschreibung des Parameters.
`type`	`enum (Type)` Der Typ des Parameters.
`required`	`boolean` Ob der Parameter erforderlich ist.
`repeated`	`boolean` Veraltet. Dieses Feld hat keine Auswirkungen.
`validationRegex`	`string` Ein regulärer Ausdruck, der zur Parametervalidierung verwendet werden kann.
`allowedValues[]`	`string` Alle zulässigen Werte für den Parameter.
`minValue`	`number` Gibt für ganzzahlige Werte und Werte mit doppelter Genauigkeit den zulässigen Mindestwert an.
`maxValue`	`number` Gibt für ganzzahlige Werte und Double-Werte den zulässigen Höchstwert an.
`fields[]`	`object (DataSourceParameter)` Veraltet. Dieses Feld hat keine Auswirkungen.
`validationDescription`	`string` Die Beschreibung der Anforderungen für dieses Feld, falls die Eingabe des Nutzers dem Muster des regulären Ausdrucks oder den Mindest-/Höchstwerten nicht entspricht.
`validationHelpUrl`	`string` Die URL zu einem Hilfedokument, in dem die Benennungsanforderungen näher erläutert werden.
`immutable`	`boolean` Kann nach dem anfänglichen Erstellvorgang nicht geändert werden.
`recurse`	`boolean` Veraltet. Dieses Feld hat keine Auswirkungen.
`deprecated`	`boolean` Wenn der Wert „true“ lautet, sollte er nicht bei neuen Übertragungen verwendet werden und für Nutzer nicht sichtbar sein.

Typ

Der Typ des Parameters.

Enums
`TYPE_UNSPECIFIED`	Der Typ ist nicht angegeben.
`STRING`	Ein Stringparameter.
`INTEGER`	Ein Ganzzahlparameter (64 Bit). Wird als String in JSON serialisiert.
`DOUBLE`	Ein Gleitkommaparameter mit doppelter Genauigkeit.
`BOOLEAN`	Ein boolescher Parameter.
`RECORD`	Veraltet. Dieses Feld hat keine Auswirkungen.
`PLUS_PAGE`	Die Seiten-ID für eine Google+ Seite.

AuthorizationType

Der Autorisierungstyp, der für diese Datenquelle erforderlich ist.

Enums
`AUTHORIZATION_TYPE_UNSPECIFIED`	Der Typ ist nicht angegeben.
`AUTHORIZATION_CODE`	Verwendet OAuth 2-Autorisierungscodes, die im Back-End gegen ein Aktualisierungstoken ausgetauscht werden können.
`GOOGLE_PLUS_AUTHORIZATION_CODE`	Gibt einen Autorisierungscode für eine bestimmte Google+ Seite zurück, der anschließend im Back-End gegen ein Aktualisierungstoken ausgetauscht werden kann.
`FIRST_PARTY_OAUTH`	Verwendet einen eigenen OAuth-Autorisierungscode anhand von LOAS-Clients. Eigene OAuth-Autorisierungscodes erfordern kein Aktualisierungstoken, um ein Offline-Zugriffstoken abzurufen. Stattdessen wird eine Client-signierte JWT-Assertion verwendet, um ein Zugriffstoken abzurufen.

DataRefreshType

Stellt dar, wie die Datenquelle die automatische Datenaktualisierung unterstützt.

Enums
`DATA_REFRESH_TYPE_UNSPECIFIED`	Die Datenquelle unterstützt die automatische Datenaktualisierung nicht. Dies ist der Standardwert.
`SLIDING_WINDOW`	Die Datenquelle unterstützt die automatische Datenaktualisierung und es werden Ausführungen für die letzten Tage geplant. Es können keine benutzerdefinierten Werte für die einzelnen Übertragungskonfigurationen festgelegt werden.
`CUSTOM_SLIDING_WINDOW`	Die Datenquelle unterstützt die automatische Datenaktualisierung und es werden Ausführungen für die letzten Tage geplant. Für die einzelnen Übertragungskonfigurationen können benutzerdefinierte Werte festgelegt werden.

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.

REST-Ressource: projects.dataSources

Ressource: DataSource

TransferType

DataSourceParameter

Typ

AuthorizationType

DataRefreshType

Methoden

`checkValidCreds`

`get`

`list`