Ressource REST : projects.locations.dataSources

Ressource : DataSource

Représente les métadonnées relatives à la source de données. Les métadonnées sont suffisantes pour afficher l'interface utilisateur et demander des jetons OAuth appropriés.

Représentation JSON 

{
  "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
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la source de données

dataSourceId

string

ID de la source de données
displayName

string

Nom convivial de la source de données
description

string

Chaîne de description conviviale de la source de donnée
clientId

string

ID client de la source de données à utiliser pour recevoir le jeton d'actualisation
scopes[]

string

Champs d'application Auth de l'API pour lesquels le jeton d'actualisation doit être obtenu. Il s'agit des champs d'application requis par une source de données pour préparer des données et les intégrer dans BigQuery, par exemple : https://www.googleapis.com/auth/bigquery.

transferType
(deprecated)

enum(TransferType)

Obsolète. Ce champ n'a aucun effet.
supportsMultipleTransfers
(deprecated)

boolean

Obsolète. Ce champ n'a aucun effet.
updateDeadlineSeconds

number

Nombre de secondes d'attente d'une mise à jour de la source de données avant que le service de transfert de données n'indique l'état ÉCHEC
defaultSchedule

string

Planification du transfert de données par défaut. Exemples de planifications valides : 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 et first sunday of quarter 00:00.

supportsCustomSchedule

boolean

Indique si la source de données est compatible avec une planification définie par l'utilisateur ou fonctionne selon la programmation par défaut. Si ce paramètre est défini sur true, l'utilisateur peut remplacer la programmation par défaut.

parameters[]

object(DataSourceParameter)

Paramètres de source de données
helpUrl

string

URL du document d'aide de cette source de données
authorizationType

enum(AuthorizationType)

Indique le type d'autorisation.
dataRefreshType

enum(DataRefreshType)

Indique si la source de données est compatible avec l'actualisation automatique des données au cours des derniers jours et la manière dont elle est compatible. Pour certaines sources, les données peuvent n'être complètes que quelques jours plus tard. Il est donc utile d'actualiser automatiquement les données.

defaultDataRefreshWindowDays

number

Fenêtre d'actualisation des données par défaut en fonction des jours. Utile seulement lorsque dataRefreshType est égal à SLIDING_WINDOW.

manualRunsDisabled

boolean

Désactive le remplissage et la planification manuelle des exécutions pour la source de données.
minimumScheduleInterval

string (Duration format)

Intervalle minimal requis pour la planification des exécutions par le planificateur

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".
redirectUrl

string

URL de redirection permettant de terminer la configuration du transfert pour les sources de données tierces

Méthodes

checkValidCreds

 Renvoie la valeur "true" si des identifiants valides existent pour la source de données présentée et l'utilisateur demandeur.

get

 Récupère une source de données compatible et renvoie ses paramètres, qui peuvent être utilisés pour l'affichage dans l'interface utilisateur.

list

 Répertorie les sources de données compatibles et renvoie leurs paramètres, qui peuvent être utilisés pour l'affichage dans l'interface utilisateur.