REST Resource: transferOperations

Ressource: TransferOperation

Eine Beschreibung der Ausführung einer Übertragung.

JSON-Darstellung 
{
  "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
}
Felder
name

string

Eine vom System zugewiesene global eindeutige ID.
projectId

string

Die ID des Google Cloud-Projekts, dem der Vorgang zugewiesen ist.
transferSpec

object (TransferSpec)

Übertragungsspezifikation.
notificationConfig

object (NotificationConfig)

Benachrichtigungskonfiguration
loggingConfig

object (LoggingConfig)

Cloud Logging-Konfiguration.
startTime

string (Timestamp format)

Startzeit dieser Übertragung.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Endzeit dieser Übertragungsausführung.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
status

enum (Status)

Status des Übertragungsvorgangs.
counters

object (TransferCounters)

Informationen zum Fortschritt der Übertragung.
errorBreakdowns[]

object (ErrorSummary)

Hier werden Fehler zusammengefasst, die in Beispielen für Fehlerprotokolleinträge aufgetreten sind.
transferJobName

string

Der Name des Übertragungsjobs, der diesen Übertragungsvorgang auslöst.

Status

Der Status einer Übertragung.

Enums
STATUS_UNSPECIFIED Null ist ein ungültiger Wert.
IN_PROGRESS Läuft.
PAUSED Pausiert.
SUCCESS Abgeschlossen.
FAILED Aufgrund eines nicht wiederherstellbaren Fehlers beendet.
ABORTED Vom Nutzer abgebrochen.
QUEUED Vorübergehend vom System verzögert. Es sind keine Maßnahmen der Nutzer erforderlich.
SUSPENDING Der Vorgang wird angehalten und die laufenden Arbeiten werden bis zum Abschluss ausgeführt.

TransferCounters

Eine Sammlung von Zählern, die den Fortschritt eines Übertragungsvorgangs anzeigen.

JSON-Darstellung 
{
  "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
}
Felder
objectsFoundFromSource

string (int64 format)

Objekte in der Datenquelle, die für die Übertragung geplant sind, ausgenommen solche, die basierend auf Objektbedingungen gefiltert oder aufgrund der Synchronisierung übersprungen werden.
bytesFoundFromSource

string (int64 format)

In der Datenquelle gefundene Bytes, die für die Übertragung geplant sind, ausgenommen solche, die aufgrund von Objektbedingungen gefiltert oder aufgrund der Synchronisierung übersprungen werden.
objectsFoundOnlyFromSink

string (int64 format)

Objekte, die nur im Datensink gefunden werden und zum Löschen geplant sind.
bytesFoundOnlyFromSink

string (int64 format)

Nur im Datensink gefundene und zum Löschen geplante Bytes.
objectsFromSourceSkippedBySync

string (int64 format)

Objekte in der Datenquelle, die nicht übertragen werden, weil sie bereits in der Datensenke vorhanden sind.
bytesFromSourceSkippedBySync

string (int64 format)

Bytes in der Datenquelle, die nicht übertragen werden, da sie bereits in der Datensenke vorhanden sind.
objectsCopiedToSink

string (int64 format)

Objekte, die in den Datensammler kopiert werden.
bytesCopiedToSink

string (int64 format)

Bytes, die in den Datensammler kopiert werden.
objectsDeletedFromSource

string (int64 format)

Objekte, die aus der Datenquelle gelöscht werden.
bytesDeletedFromSource

string (int64 format)

Bytes, die aus der Datenquelle gelöscht werden.
objectsDeletedFromSink

string (int64 format)

Objekte, die aus dem Datensink gelöscht werden.
bytesDeletedFromSink

string (int64 format)

Bytes, die aus dem Datensink gelöscht werden.
objectsFromSourceFailed

string (int64 format)

Objekte in der Datenquelle, die nicht übertragen oder nach der Übertragung nicht gelöscht werden konnten.
bytesFromSourceFailed

string (int64 format)

Bytes in der Datenquelle, die nicht übertragen oder nach der Übertragung nicht gelöscht werden konnten.
objectsFailedToDeleteFromSink

string (int64 format)

Objekte, die nicht aus dem Datensink gelöscht werden konnten.
bytesFailedToDeleteFromSink

string (int64 format)

Bytes, die nicht aus dem Datensink gelöscht werden konnten.
directoriesFoundFromSource

string (int64 format)

Nur für Übertragungen mit PosixFilesystem.

Anzahl der Verzeichnisse, die beim Auflisten gefunden wurden. Wenn das Stammverzeichnis der Übertragung beispielsweise base/ ist und sich in diesem Verzeichnis zwei weitere Verzeichnisse befinden, a/ und b/, beträgt die Anzahl nach dem Auflisten von base/, base/a/ und base/b/ 3.
directoriesFailedToListFromSource

string (int64 format)

Nur für Übertragungen mit PosixFilesystem.

Anzahl der Eintragsfehler für jedes Verzeichnis, das in der Quelle gefunden wurde. Mögliche Fehler beim Auflisten eines Verzeichnisses sind Berechtigungs- oder Blockierungsfehler. Wenn das Auflisten eines Verzeichnisses fehlschlägt, werden keine Dateien im Verzeichnis übertragen.
directoriesSuccessfullyListedFromSource

string (int64 format)

Nur für Übertragungen mit PosixFilesystem.

Anzahl der erfolgreichen Einträge für jedes Verzeichnis, das in der Quelle gefunden wurde.
intermediateObjectsCleanedUp

string (int64 format)

Anzahl der erfolgreich bereinigten Zwischenobjekte.
intermediateObjectsFailedCleanedUp

string (int64 format)

Anzahl der Zwischenobjekte, die nicht bereinigt werden konnten.

ErrorSummary

Eine Zusammenfassung der Fehler nach Fehlercode sowie eine Zählung und Beispieleinträge aus dem Fehlerprotokoll.

JSON-Darstellung 
{
  "errorCode": enum (Code),
  "errorCount": string,
  "errorLogEntries": [
    {
      object (ErrorLogEntry)
    }
  ]
}
Felder
errorCode

enum (Code)

Pflichtangabe.
errorCount

string (int64 format)

Pflichtangabe. Anzahl dieser Art von Fehler.
errorLogEntries[]

object (ErrorLogEntry)

Fehlerbeispiele

Für einen bestimmten Fehlercode werden für einen einzelnen Übertragungsvorgang maximal fünf Fehlerprotokolleinträge protokolliert.

Code

Die kanonischen Fehlercodes für Google APIs.

Enums
OK

Kein Fehler; wird bei Erfolg angezeigt.

HTTP Mapping: 200 OK
CANCELLED

Der Vorgang wurde abgebrochen, üblicherweise vom Aufrufer.

HTTP Mapping: 499 Client Closed Request
UNKNOWN

Unbekannter Fehler. Dieser Fehler wird beispielsweise ausgegeben, wenn ein Status-Wert, der von einem anderen Adressbereich stammt, zu einem Fehlerbereich gehört, der in diesem Adressbereich nicht bekannt ist. Auch Fehler, die von APIs ausgelöst werden, die nicht genügend Fehlerinformationen liefern, können in diesen Fehler umgewandelt werden.

HTTP Mapping: 500 Internal Server Error
INVALID_ARGUMENT

Der Client hat ein ungültiges Argument angegeben. Dieser Wert ist nicht identisch mit FAILED_PRECONDITION. INVALID_ARGUMENT gibt Argumente an, die ungeachtet des Systemstatus problematisch sind (z. B. ein ungültiger Dateiname).

HTTP Mapping: 400 Bad Request
DEADLINE_EXCEEDED

Die Frist ist abgelaufen, bevor der Vorgang abgeschlossen werden konnte. Bei Vorgängen, die den Systemstatus verändern, kann dieser Fehler angezeigt werden, auch wenn der Vorgang erfolgreich abgeschlossen wurde. Zum Beispiel könnte eine erfolgreiche Antwort von einem Server so lange verzögert worden sein, dass die Frist abgelaufen ist.

HTTP Mapping: 504 Gateway Timeout
NOT_FOUND

Eine angeforderte Entität (z. B. Datei oder Verzeichnis) wurde nicht gefunden.

Hinweis für Serverentwickler: Wenn eine Anfrage, z. B. eine schrittweise Einführung von Funktionen oder eine undokumentierte Zulassungsliste, für eine gesamte Nutzerklasse abgelehnt wird, kann NOT_FOUND verwendet werden. Wenn eine Anfrage, z. B. nutzerbasierte Zugriffssteuerung, für einige Nutzer innerhalb einer Nutzerklasse abgelehnt wird, muss PERMISSION_DENIED verwendet werden.

HTTP Mapping: 404 Not Found
ALREADY_EXISTS

Die Entität, die ein Client erstellen wollte (z. B. eine Datei oder ein Verzeichnis), ist bereits vorhanden.

HTTP Mapping: 409 Conflict
PERMISSION_DENIED

Der Aufrufer hat keine Berechtigung zur Ausführung des angegebenen Vorgangs. PERMISSION_DENIED darf nicht für Ablehnungen verwendet werden, die dadurch verursacht werden, dass eine Ressource erschöpft ist (verwenden Sie stattdessen RESOURCE_EXHAUSTED für diese Fehler). PERMISSION_DENIED darf nicht verwendet werden, wenn der Aufrufer nicht ermittelt werden kann (verwenden Sie stattdessen UNAUTHENTICATED für diese Fehler). Dieser Fehlercode impliziert nicht, dass die Anfrage gültig ist oder die angefragte Entität existiert oder andere Vorbedingungen erfüllt.

HTTP Mapping: 403 Forbidden
UNAUTHENTICATED

Die Anfrage enthält keine gültigen Authentifizierungsanmeldedaten für diesen Vorgang.

HTTP Mapping: 401 Unauthorized
RESOURCE_EXHAUSTED

Eine Ressource, z. B. ein nutzerbezogenes Kontingent, ist erschöpft oder der Speicherplatz für das gesamte Dateisystem ist ausgegangen.

HTTP Mapping: 429 Too Many Requests
FAILED_PRECONDITION

Der Vorgang wurde abgelehnt, weil der Systemzustand nicht für die Ausführung des Vorgangs geeignet ist. Beispielsweise ist das zu löschende Verzeichnis nicht leer, ein rmdir-Vorgang wird auf eine Ressource angewendet, die kein Verzeichnis ist, usw.

Dienstimplementierungen können anhand der folgenden Richtlinien zwischen FAILED_PRECONDITION, ABORTED und UNAVAILABLE entscheiden: (a) Verwenden Sie UNAVAILABLE, wenn der Client nur den fehlgeschlagenen Aufruf wiederholen kann. (b) Verwenden Sie ABORTED, wenn der Client den Vorgang auf einer höheren Ebene wiederholen soll. Beispiel: Ein vom Kunden angegebener Test- und Set-Wert fehlschlägt. Dies bedeutet, dass der Client eine Read-Modify-Write-Sequenz startet. (c) Sollte der Client den Fehler nicht wiederholen, bis der Systemstatus ausdrücklich festgelegt wurde, verwenden Sie FAILED_PRECONDITION. Wenn beispielsweise ein "rmdir" fehlschlägt, weil das Verzeichnis nicht leer ist, sollte FAILED_PRECONDITION angezeigt werden, da der Client den erneuten Versuch erst dann machen sollte, wenn die Dateien aus dem Verzeichnis gelöscht wurden.

HTTP Mapping: 400 Bad Request
ABORTED

Der Vorgang wurde abgebrochen, in der Regel aufgrund eines Parallelitätsproblems wie einer fehlgeschlagenen Sequencer-Überprüfung oder einer abgebrochenen Transaktion.

Siehe obige Richtlinien zum Abwägen zwischen FAILED_PRECONDITION, ABORTED und UNAVAILABLE.

HTTP Mapping: 409 Conflict
OUT_OF_RANGE

Beim Vorgang wurde versucht, den gültigen Bereich zu überschreiten. Beispiel: Such- oder Lesevorgang über das Dateiende hinaus.

Im Gegensatz zu INVALID_ARGUMENT zeigt dieser Fehler ein Problem an, das behoben werden kann, wenn sich der Systemstatus ändert. Zum Beispiel erzeugt ein 32-Bit-Dateisystem INVALID_ARGUMENT, wenn es in einem Bereich lesen soll, der nicht innerhalb des Bereichs [0,2^32-1] liegt. Dagegen generiert es OUT_OF_RANGE, wenn für einen Bereich gelesen werden soll, der die aktuelle Dateigröße übersteigt.

Es gibt einige Überschneidungen zwischen FAILED_PRECONDITION und OUT_OF_RANGE. Wir empfehlen die Verwendung von OUT_OF_RANGE (der spezifischere Fehler), wenn dies zutrifft, damit die Aufrufer, die über einen Bereich iterieren, einfach nach einem OUT_OF_RANGE-Fehler suchen können, wenn sie fertig sind.

HTTP Mapping: 400 Bad Request
UNIMPLEMENTED

Dieser Vorgang ist nicht implementiert oder wird bei diesem Dienst nicht unterstützt bzw. ist bei diesem Dienst nicht aktiviert.

HTTP Mapping: 501 Not Implemented
INTERNAL

Interne Fehler. Das bedeutet, dass einige Invarianten, die vom zugrunde liegenden System erwartet werden, nicht erfüllt wurden. Dieser Fehlercode ist für schwerwiegende Fehler reserviert.

HTTP Mapping: 500 Internal Server Error
UNAVAILABLE

Der Dienst ist derzeit nicht verfügbar. Dies ist höchstwahrscheinlich ein vorübergehender Zustand, der durch Wiederholen mit einem Backoff korrigiert werden kann. Es ist nicht immer sicher, nicht idempotente Vorgänge zu wiederholen.

Siehe obige Richtlinien zum Abwägen zwischen FAILED_PRECONDITION, ABORTED und UNAVAILABLE.

HTTP Mapping: 503 Service Unavailable
DATA_LOSS

Dauerhafter Datenverlust oder Datenkorruption.

HTTP Mapping: 500 Internal Server Error

ErrorLogEntry

Ein Eintrag, der einen aufgetretenen Fehler beschreibt.

JSON-Darstellung 
{
  "url": string,
  "errorDetails": [
    string
  ]
}
Felder
url

string

Pflichtangabe. Eine URL, die sich auf das Ziel (eine Datenquelle, einen Datensammler oder ein Objekt) bezieht, mit dem der Fehler verknüpft ist.
errorDetails[]

string

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten.

Methoden

cancel

 Bricht eine Übertragung ab.

get

 Ruft den letzten Status eines lange laufenden Vorgangs ab.

list

 Listet Übertragungsvorgänge auf.

pause

 Pausiert einen Übertragungsvorgang.

resume

 Fortsetzt einen angehaltenen Übertragungsvorgang.