Ressource REST : projects.transferConfigs

Ressource : TransferConfig

Représente une configuration de transfert de données. Une configuration de transfert contient toutes les métadonnées nécessaires à un transfert de données. Par exemple, destinationDatasetId spécifie l'emplacement de stockage des données. Lorsqu'une configuration de transfert est créée, l'ID destinationDatasetId spécifié est créé si nécessaire et partagé avec le compte de service de source de données approprié.

Représentation JSON 

{
  "name": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "scheduleOptions": {
    object (ScheduleOptions)
  },
  "dataRefreshWindowDays": integer,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum (TransferState),
  "userId": string,
  "datasetRegion": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
Champs
name

string

Nom de ressource de la configuration de transfert. Les noms de configuration de transfert se présentent au format suivant : projects/{projectId}/locations/{region}/transferConfigs/{configId}. Le nom est généré automatiquement en fonction de l'élément configId spécifié dans CreateTransferConfigRequest, avec l'ID de projet et la région. Si vous ne spécifiez pas d'élément configId (généralement un UUID), un nom sera généré pour configId même s'il n'est pas garanti ni requis.
displayName

string

Nom à afficher spécifié par l'utilisateur pour le transfert de données.
dataSourceId

string

ID de la source de données. Ne peut pas être modifié une fois le transfert de données créé.
params

object (Struct format)

Paramètres spécifiques du transfert de données.
schedule

string

Planification du transfert de données. Si la source de données n'est pas compatible avec une planification personnalisée, ce champ doit être vide. Si ce champ est vide, la valeur par défaut de la source de données est utilisée. Les heures spécifiées sont exprimées en temps UTC. Exemples de format valide : 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15 et first sunday of quarter 00:00. Pour en savoir plus sur le format, consultez la page https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format REMARQUE : La précision doit être d'au moins huit heures ou la fréquence doit être moins élevée.
scheduleOptions

object (ScheduleOptions)

Options permettant de personnaliser la planification du transfert de données.
dataRefreshWindowDays

integer

Nombre de jours à remonter pour l'actualisation automatique des données. Par exemple, si dataRefreshWindowDays = 10, BigQuery réingérera chaque jour les données pour [aujourd'hui-10, aujourd'hui-1] au lieu d'ingérer des données pour seulement [aujourd'hui-1]. Valide uniquement si la source de données est compatible avec cette fonctionnalité. Définissez la valeur sur zéro pour utiliser la valeur par défaut.
disabled

boolean

Spécifie si la configuration est désactivée ou non. Si cette valeur est définie sur "true", aucune exécution n'est programmée pour un transfert donné.
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de modification du transfert de données. Ignoré par le serveur lors de la saisie.
nextRunTime

string (Timestamp format)

Uniquement en sortie. La prochaine fois que le transfert de données sera exécuté.
state

enum (TransferState)

Uniquement en sortie. État de la dernière exécution de transfert mise à jour.
userId

string (int64 format)

Obsolète. Identifiant unique de l'utilisateur au nom duquel le transfert est effectué.
datasetRegion

string

Uniquement en sortie. Région dans laquelle se trouve l'ensemble de données BigQuery.
notificationPubsubTopic

string

Sujet Pub/Sub dans lequel les notifications seront envoyées une fois les exécutions de transfert associées à cette configuration de transfert terminées.
emailPreferences

object (EmailPreferences)

Les notifications par e-mail seront envoyées en fonction de ces préférences à l'adresse e-mail de l'utilisateur propriétaire de cette configuration de transfert.
destinationDatasetId

string

ID de l'ensemble de données cible BigQuery.

Méthodes

create

 Crée une configuration de transfert de données.

delete

 Supprime une configuration de transfert de données, y compris les exécutions de transfert et les journaux associés.

get

 Renvoie des informations sur une configuration de transfert de données.

list

 Renvoie des informations sur tous les transferts de données du projet.

patch

 Met à jour une configuration de transfert de données.

scheduleRuns
(deprecated)

 Crée des exécutions de transfert pour une période [start_time, end_time].

startManualRuns

 Démarre manuellement des exécutions de transfert, où la valeur schedule_time est égale à l'heure actuelle.