REST Resource: transferOperations

Ressource: TransferOperation

Description de l'exécution d'un transfert.

Représentation JSON
{
  "name": string,
  "projectId": string,
  "transferSpec": {
    object (TransferSpec)
  },
  "notificationConfig": {
    object (NotificationConfig)
  },
  "loggingConfig": {
    object (LoggingConfig)
  },
  "startTime": string,
  "endTime": string,
  "status": enum (Status),
  "counters": {
    object (TransferCounters)
  },
  "errorBreakdowns": [
    {
      object (ErrorSummary)
    }
  ],
  "transferJobName": string
}
Champs
name

string

Identifiant unique global attribué par le système.

projectId

string

ID du projet Google Cloud propriétaire de l'opération.

transferSpec

object (TransferSpec)

Spécification de transfert.

notificationConfig

object (NotificationConfig)

Configuration des notifications.

loggingConfig

object (LoggingConfig)

Configuration de Cloud Logging.

startTime

string (Timestamp format)

Heure de début de l'exécution de ce transfert.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Heure de fin de cette exécution de transfert.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

status

enum (Status)

État de l'opération de transfert.

counters

object (TransferCounters)

Informations sur la progression de l'opération de transfert.

errorBreakdowns[]

object (ErrorSummary)

Résume les erreurs rencontrées avec des exemples d'entrées de journal d'erreur.

transferJobName

string

Nom de la tâche de transfert qui déclenche cette opération de transfert.

État

État d'une TransferOperation.

Enums
STATUS_UNSPECIFIED La valeur zéro n'est pas autorisée.
IN_PROGRESS En cours.
PAUSED En pause.
SUCCESS Opération réussie.
FAILED Arrêté en raison d'une défaillance irrécupérable.
ABORTED Arrêté par l'utilisateur.
QUEUED Retard temporaire par le système. Aucune action n'est requise de la part de l'utilisateur.
SUSPENDING L'opération suspend et vide le travail en cours jusqu'à son achèvement.

TransferCounters

Ensemble de compteurs qui indiquent la progression d'une opération de transfert.

Représentation JSON
{
  "objectsFoundFromSource": string,
  "bytesFoundFromSource": string,
  "objectsFoundOnlyFromSink": string,
  "bytesFoundOnlyFromSink": string,
  "objectsFromSourceSkippedBySync": string,
  "bytesFromSourceSkippedBySync": string,
  "objectsCopiedToSink": string,
  "bytesCopiedToSink": string,
  "objectsDeletedFromSource": string,
  "bytesDeletedFromSource": string,
  "objectsDeletedFromSink": string,
  "bytesDeletedFromSink": string,
  "objectsFromSourceFailed": string,
  "bytesFromSourceFailed": string,
  "objectsFailedToDeleteFromSink": string,
  "bytesFailedToDeleteFromSink": string,
  "directoriesFoundFromSource": string,
  "directoriesFailedToListFromSource": string,
  "directoriesSuccessfullyListedFromSource": string,
  "intermediateObjectsCleanedUp": string,
  "intermediateObjectsFailedCleanedUp": string
}
Champs
objectsFoundFromSource

string (int64 format)

Objets trouvés dans la source de données et programmés pour être transférés, à l'exception de ceux qui sont filtrés en fonction des conditions des objets ou ignorés en raison de la synchronisation.

bytesFoundFromSource

string (int64 format)

Octets trouvés dans la source de données et programmés pour être transférés, à l'exception de ceux qui sont filtrés en fonction des conditions des objets ou ignorés en raison de la synchronisation.

objectsFoundOnlyFromSink

string (int64 format)

Objets trouvés uniquement dans le collecteur de données et dont la suppression est planifiée.

bytesFoundOnlyFromSink

string (int64 format)

Octets trouvés uniquement dans le collecteur de données et programmés pour être supprimés.

objectsFromSourceSkippedBySync

string (int64 format)

Objets de la source de données qui ne sont pas transférés, car ils existent déjà dans le récepteur de données.

bytesFromSourceSkippedBySync

string (int64 format)

Octets de la source de données qui ne sont pas transférés, car ils existent déjà dans le récepteur de données.

objectsCopiedToSink

string (int64 format)

Objets copiés dans le collecteur de données.

bytesCopiedToSink

string (int64 format)

Octets copiés dans le collecteur de données.

objectsDeletedFromSource

string (int64 format)

Objets supprimés de la source de données

bytesDeletedFromSource

string (int64 format)

Octets supprimés de la source de données.

objectsDeletedFromSink

string (int64 format)

Objets supprimés du collecteur de données

bytesDeletedFromSink

string (int64 format)

Octets supprimés du collecteur de données.

objectsFromSourceFailed

string (int64 format)

Objets de la source de données qui n'ont pas été transférés ou qui n'ont pas été supprimés après avoir été transférés.

bytesFromSourceFailed

string (int64 format)

Octets de la source de données qui n'ont pas pu être transférés ou qui n'ont pas pu être supprimés après avoir été transférés.

objectsFailedToDeleteFromSink

string (int64 format)

Objets qui n'ont pas pu être supprimés du collecteur de données.

bytesFailedToDeleteFromSink

string (int64 format)

Octets qui n'ont pas pu être supprimés du collecteur de données.

directoriesFoundFromSource

string (int64 format)

Pour les transferts impliquant PosixFilesystem uniquement.

Nombre d'annuaires trouvés lors de la liste. Par exemple, si le répertoire racine du transfert est base/ et qu'il existe deux autres répertoires, a/ et b/, sous ce répertoire, le nombre après avoir listé base/, base/a/ et base/b/ est de trois.

directoriesFailedToListFromSource

string (int64 format)

Pour les transferts impliquant PosixFilesystem uniquement.

Nombre d'échecs de création de fiches pour chaque répertoire trouvé dans la source. Les échecs potentiels lors de la liste d'un répertoire incluent les échecs d'autorisation ou de blocage. Si la liste d'un répertoire échoue, aucun fichier du répertoire n'est transféré.

directoriesSuccessfullyListedFromSource

string (int64 format)

Pour les transferts impliquant PosixFilesystem uniquement.

Nombre de fiches créées pour chaque répertoire trouvé dans la source.

intermediateObjectsCleanedUp

string (int64 format)

Nombre d'objets intermédiaires nettoyés avec succès.

intermediateObjectsFailedCleanedUp

string (int64 format)

Nombre d'objets intermédiaires non nettoyés.

ErrorSummary

Récapitulatif des erreurs par code d'erreur, ainsi qu'un nombre et des exemples d'entrées de journal d'erreur.

Représentation JSON
{
  "errorCode": enum (Code),
  "errorCount": string,
  "errorLogEntries": [
    {
      object (ErrorLogEntry)
    }
  ]
}
Champs
errorCode

enum (Code)

Obligatoire.

errorCount

string (int64 format)

Obligatoire. Nombre de ce type d'erreur.

errorLogEntries[]

object (ErrorLogEntry)

Exemples d'erreurs.

Cinq entrées de journal d'erreurs au maximum sont enregistrées pour un code d'erreur donné pour une seule opération de transfert.

Code

Les codes d'erreur canoniques pour les API Google.

Enums
OK

Pas une erreur, affiché en cas de réussite.

Mise en correspondance HTTP : 200 OK

CANCELLED

L'opération a été annulée, généralement par l'appelant.

Mise en correspondance HTTP : 499 Le client a fermé la requête

UNKNOWN

Erreur inconnue. Par exemple, cette erreur peut s'afficher lorsqu'une valeur Status reçue d'un autre espace d'adressage appartient à un espace d'erreur inconnu dans cet espace d'adressage. De plus, les erreurs des API qui ne renvoient pas suffisamment d'informations relatives aux erreurs peuvent être converties dans cette erreur.

Mise en correspondance HTTP : 500 Erreur de serveur interne

INVALID_ARGUMENT

Le client a spécifié un argument non valide. Notez que cette erreur diffère de FAILED_PRECONDITION. INVALID_ARGUMENT indique les arguments problématiques quel que soit l'état du système (par exemple, un nom de fichier incorrect).

Mise en correspondance HTTP : 400 Requête incorrecte

DEADLINE_EXCEEDED

Le délai a expiré avant que l'opération puisse se terminer. Pour les opérations qui modifient l'état du système, cette erreur peut être affichée même si l'opération s'est terminée avec succès. Par exemple, une réponse réussie d'un serveur aurait pu être retardée suffisamment longtemps pour que le délai expire.

Mappage HTTP : 504 Passerelle hors délai

NOT_FOUND

Une entité demandée (fichier ou répertoire, par exemple) est introuvable.

Remarque pour les développeurs de serveurs : NOT_FOUND peut être utilisé si une requête est refusée pour toute une classe d'utilisateurs, telle que le déploiement progressif des fonctionnalités ou la liste d'autorisation non documentée. Si une requête est refusée pour certains utilisateurs appartenant à une classe d'utilisateurs, telle que le contrôle des accès basé sur l'utilisateur, PERMISSION_DENIED doit être utilisé.

Mise en correspondance HTTP : 404 Page introuvable

ALREADY_EXISTS

L'entité qu'un client a tenté de créer (par exemple, un fichier ou un répertoire) existe déjà.

Mise en correspondance HTTP : 409 Conflit

PERMISSION_DENIED

L'appelant n'a pas l'autorisation d'exécuter l'opération spécifiée. PERMISSION_DENIED ne doit pas être utilisé pour les rejets causés par l'épuisement d'une ressource (utilisez plutôt RESOURCE_EXHAUSTED pour ces erreurs). PERMISSION_DENIED ne doit pas être utilisé si l'appelant ne peut pas être identifié (utilisez plutôt UNAUTHENTICATED pour ces erreurs). Ce code d'erreur n'implique pas que la requête soit valide ni que l'entité demandée existe ou qu'elle répond à d'autres pré-requis.

Mise en correspondance HTTP : 403 Accès interdit

UNAUTHENTICATED

La requête ne dispose pas d'identifiants d'authentification valides pour l'opération.

Mise en correspondance HTTP : 401 Accès non autorisé

RESOURCE_EXHAUSTED

Certaines ressources ont été épuisées ; par exemple, un quota par utilisateur a été atteint ou le système de fichiers dans son intégralité manque d'espace.

Mise en correspondance HTTP : 429 Requêtes trop nombreuses

FAILED_PRECONDITION

L'opération a été rejetée car le système n'est pas dans un état requis pour exécuter l'opération. Par exemple, le répertoire à supprimer n'est pas vide, une opération rmdir est appliquée à un emplacement qui n'est pas un répertoire, etc.

Les développeurs de services peuvent suivre les instructions suivantes pour choisir entre FAILED_PRECONDITION, ABORTED et UNAVAILABLE : (a) Utilisez UNAVAILABLE si le client ne peut relancer que l'appel ayant échoué. (b) Utilisez ABORTED si le client doit effectuer une nouvelle tentative à un niveau supérieur (par exemple, lorsqu'un test-and-set spécifié par le client échoue, indiquant que le client doit redémarrer une séquence lecture-modification-écriture). (c) Utilisez FAILED_PRECONDITION si le client ne doit pas effectuer de nouvelle tentative tant que l'état du système n'a pas été explicitement corrigé. Par exemple, si un "rmdir" échoue parce que le répertoire n'est pas vide, FAILED_PRECONDITION doit être affiché car le client ne doit pas réessayer sauf si les fichiers sont supprimés du répertoire.

Mise en correspondance HTTP : 400 Requête incorrecte

ABORTED

L'opération a été abandonnée, généralement en raison d'un problème de simultanéité, tel qu'un échec de vérification du séquenceur ou un abandon de transaction.

Consultez les instructions ci-dessus pour choisir entre FAILED_PRECONDITION, ABORTED et UNAVAILABLE.

Mise en correspondance HTTP : 409 Conflit

OUT_OF_RANGE

L'opération a été tentée au-delà de la plage valide. Par exemple, rechercher ou lire après la fin du fichier.

Contrairement à INVALID_ARGUMENT, cette erreur indique un problème pouvant être résolu si l'état du système change. Par exemple, un système de fichiers 32 bits génère INVALID_ARGUMENT s'il est invité à lire avec un décalage qui n'est pas compris dans la plage [0,2^32-1], mais génère OUT_OF_RANGE s'il est invité à lire avec un décalage qui dépasse la taille du fichier actuel.

Il existe des cas où FAILED_PRECONDITION et OUT_OF_RANGE se chevauchent. Nous vous recommandons d'utiliser OUT_OF_RANGE (l'erreur la plus spécifique) lorsque celle-ci s'applique afin que les appelants qui itèrent dans un espace puissent facilement rechercher une erreur OUT_OF_RANGE pour détecter le moment où ils ont terminé.

Mise en correspondance HTTP : 400 Requête incorrecte

UNIMPLEMENTED

L'opération n'est pas implémentée ou n'est pas prise en charge/activée dans ce service.

Mise en correspondance HTTP : 501 Non implémenté

INTERNAL

Erreurs internes. Cela signifie que certains invariants attendus par le système sous-jacent n'ont pas été respectés. Ce code d'erreur est réservé aux erreurs graves.

Mise en correspondance HTTP : 500 Erreur de serveur interne

UNAVAILABLE

Le service est actuellement indisponible. Il s'agit probablement d'une condition temporaire qui peut être corrigée en réessayant après avoir laissé passer un intervalle entre les tentatives. Notez qu'il n'est pas toujours sûr de relancer des opérations non idempotentes.

Consultez les instructions ci-dessus pour choisir entre FAILED_PRECONDITION, ABORTED et UNAVAILABLE.

Mise en correspondance HTTP : 503 Service non disponible

DATA_LOSS

Perte ou corruption de données irrécupérable.

Mise en correspondance HTTP : 500 Erreur de serveur interne

ErrorLogEntry

Entrée décrivant une erreur qui s'est produite.

Représentation JSON
{
  "url": string,
  "errorDetails": [
    string
  ]
}
Champs
url

string

Obligatoire. URL qui fait référence à la cible (une source de données, un collecteur de données ou un objet) à laquelle l'erreur est associée.

errorDetails[]

string

Liste de messages comportant les détails de l'erreur.

Méthodes

cancel

Annule un transfert.

get

Récupère le dernier état d'une opération de longue durée.

list

Répertorie les opérations de transfert.

pause

Suspend une opération de transfert.

resume

Relance une opération de transfert mise en pause.