Ressource REST : projects.locations.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 prennent la forme suivante : projects/{projectId}/locations/{region}/transferConfigs/{configId}. Le nom est généré automatiquement en fonction de l'ID de configuration 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 pour le 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 sera 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éfinie sur une fréquence d'au moins huit heures, ou sur une fréquence moins élevée.
scheduleOptions

object (ScheduleOptions)

Options permettant de personnaliser le calendrier de transfert des données
dataRefreshWindowDays

integer

Nombre de jours à remonter pour l'actualisation automatique des données. Par exemple, si dataRefreshWindowDays = 10, alors 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

Configuration désactivée. 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 après l'exécution du transfert associé à cette configuration de transfert
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

Options de programmation

Options permettant de personnaliser le calendrier de transfert des données

Représentation JSON 

{
  "disableAutoScheduling": boolean,
  "startTime": string,
  "endTime": string
}
Champs
disableAutoScheduling

boolean

Si la valeur est "true", la planification automatique des exécutions de transferts de données pour cette configuration sera désactivée. Les exécutions peuvent être démarrées sur une base ad hoc à l'aide de l'API transferConfigs.startManualRuns. Lorsque la planification automatique est désactivée, le champ TransferConfig.schedule est ignoré.
startTime

string (Timestamp format)

Spécifie l'heure de début de la planification des exécutions de transfert. La première exécution sera planifiée à l'heure de début ou après l'heure de début, selon un modèle de récurrence défini dans la chaîne de planification. L'heure de début peut être modifiée à tout moment. Cette option ne s'applique pas à l'heure à laquelle le transfert de données peut être déclenché manuellement.
endTime

string (Timestamp format)

Définit l'heure d'arrêt de la planification des exécutions de transfert. Une exécution de transfert ne peut être planifiée ni à l'heure de fin ni après l'heure de fin. L'heure de fin peut être modifiée à tout moment. Cette option ne s'applique pas à l'heure à laquelle le transfert de données peut être déclenché manuellement.

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 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.