Ressource REST : projects.locations.transferConfigs.runs

Ressource : TransferRun

Représente l'exécution d'un transfert de données.

Représentation JSON

{
  "name": string,
  "scheduleTime": string,
  "runTime": string,
  "errorStatus": {
    object (Status)
  },
  "startTime": string,
  "endTime": string,
  "updateTime": string,
  "params": {
    object
  },
  "dataSourceId": string,
  "state": enum (TransferState),
  "userId": string,
  "schedule": string,
  "notificationPubsubTopic": string,
  "emailPreferences": {
    object (EmailPreferences)
  },
  "destinationDatasetId": string
}
Champs
name

string

Nom de ressource de l'exécution de transfert. Les noms des exécutions de transfert sont au format projects/{projectId}/locations/{location}/transferConfigs/{configId}/runs/{run_id}. Le nom est ignoré lors de la création d'une exécution de transfert.

scheduleTime

string (Timestamp format)

Délai minimum après lequel une exécution de transfert peut être lancée.

runTime

string (Timestamp format)

Pour les exécutions de transfert par lot, ce champ spécifie la date et l'heure auxquelles les données doivent être ingérées.

errorStatus

object (Status)

État de l'exécution du transfert.

startTime

string (Timestamp format)

Uniquement en sortie. Heure de début de l'exécution du transfert. Paramètre ignoré par le serveur pour les requêtes entrantes.

endTime

string (Timestamp format)

Uniquement en sortie. Heure de fin de l'exécution du transfert. Paramètre ignoré par le serveur pour les requêtes entrantes.

updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de l'état d'exécution du transfert de données.

params

object (Struct format)

Uniquement en sortie. Paramètres spécifiques du transfert de données.

dataSourceId

string

Uniquement en sortie. ID de la source de données.

state

enum (TransferState)

État de l'exécution du transfert de données. Ignoré pour les requêtes entrantes.

userId

string (int64 format)

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

schedule

string

Uniquement en sortie. Décrit la programmation de l'exécution de transfert si elle a été créée dans le cadre d'une programmation régulière. Pour les exécutions de transfert par lot programmées manuellement, ce champ est vide. REMARQUE : le système peut choisir de retarder la programmation en fonction de la charge actuelle. Par conséquent, scheduleTime ne correspond pas toujours à ce champ.

notificationPubsubTopic

string

Uniquement en sortie. Sujet Pub/Sub dans lequel une notification est envoyée à la fin de l'exécution du transfert.

emailPreferences

object (EmailPreferences)

Uniquement en sortie. Les notifications par e-mail sont envoyées en fonction de ces préférences à l'adresse e-mail de l'utilisateur propriétaire de la configuration de transfert dont cette exécution est issue.

destinationDatasetId

string

Uniquement en sortie. ID de l'ensemble de données BigQuery cible.

Status

Le type Status définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.

Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.

Représentation JSON

{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Champs
code

integer

Code d'état, qui doit être une valeur d'énumération de google.rpc.Code.

message

string

Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ google.rpc.Status.details, ou localisé par le client.

details[]

object

Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Méthodes

delete

Supprime l'exécution de transfert spécifiée.

get

Renvoie des informations sur l'exécution d'un transfert spécifique.

list

Renvoie des informations sur les tâches en cours ou terminées.