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,
  "destinationDatasetId": string,
  "displayName": string,
  "dataSourceId": string,
  "params": {
    object
  },
  "schedule": string,
  "dataRefreshWindowDays": number,
  "disabled": boolean,
  "updateTime": string,
  "nextRunTime": string,
  "state": enum(TransferState),
  "userId": string,
  "datasetRegion": string,
  "partnerToken": string,
  "partnerConnectionInfo": {
    object
  }
}
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.

destinationDatasetId

string

ID de l'ensemble de données cible BigQuery
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 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éfinie sur une fréquence d'au moins huit heures, ou sur une fréquence moins élevée.

dataRefreshWindowDays

number

Nombre de jours en fonction desquels l'actualisation automatique des données doit revenir en arrière. 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

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.

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z".
nextRunTime

string (Timestamp format)

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

Horodatage au format RFC3339 UTC "Zulu", précis à la nanoseconde près. Exemple : "2014-10-02T15:01:23.045123456Z".
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.

partnerToken

string

Identifiant unique permettant d'identifier une configuration de transfert stockée côté partenaire externe. Le jeton est opaque à DTS et ne peut être interprété que par le partenaire. La source de données du partenaire doit créer un mappage entre l'ID de configuration et le jeton pour confirmer qu'une configuration ou une exécution de transfert est légitime.

partnerConnectionInfo

object (Struct format)

Paramètres de transfert gérés par les sources de données du partenaire. Ils sont stockés sous forme de paires clé/valeur et ne sont utilisés qu'à des fins d'affichage dans l'UI du service de transfert de données. Nous ne voulons pas les stocker avec les champs "params" pour deux raisons : les informations de connexion sont fournies par le partenaire et ne sont pas modifiables dans l'UI du service de transfert de données, contrairement au paramètre immuable. L'ajout d'une autre valeur booléenne à DataSourceParameter est source de confusion pour les distinguer. Les informations de connexion peuvent être des paires clé/valeur arbitraires. Pour les ajouter aux champs "params", le partenaire doit indiquer leur définition dans la définition de la source de données. Il sera plus facile d'éviter cela pour les partenaires.

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

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