BatchJob

Eine Liste der Mutationen, die asynchron verarbeitet werden. Die Mutationen werden vom Nutzer hochgeladen. Die Mutate-Objekte selbst sind nicht lesbar und die Ergebnisse des Jobs können nur mit BatchJobService.ListBatchJobResults gelesen werden.

JSON-Darstellung
{
  "resourceName": string,
  "metadata": {
    object (BatchJobMetadata)
  },
  "status": enum (BatchJobStatus),
  "id": string,
  "nextAddSequenceToken": string,
  "longRunningOperation": string
}
Felder
resourceName

string

Nicht veränderbar. Der Ressourcenname des Batchjobs. Ressourcennamen von Batchjobs haben folgendes Format:

customers/{customerId}/batchJobs/{batch_job_id}

metadata

object (BatchJobMetadata)

Nur Ausgabe. Enthält zusätzliche Informationen zu diesem Batchjob.

status

enum (BatchJobStatus)

Nur Ausgabe. Status dieses Batchjobs.

id

string (int64 format)

Nur Ausgabe. ID dieses Batchjobs.

nextAddSequenceToken

string

Nur Ausgabe. Das nächste Sequenztoken, das beim Hinzufügen von Vorgängen verwendet werden soll. Nur festgelegt, wenn der Status des Batchjobs „AUSSTEHEND“ ist.

longRunningOperation

string

Nur Ausgabe. Der Ressourcenname des lang andauernden Vorgangs, der für den Abschluss abgefragt werden kann. Nur festgelegt, wenn der Status des Batchjobs „RUNNING“ oder „DONE“ lautet.

BatchJobMetadata

Zusätzliche Informationen zum Batchjob. Diese Nachricht wird auch als Metadaten verwendet, die in Batchjobs mit Vorgängen mit langer Ausführungszeit zurückgegeben werden.

JSON-Darstellung
{
  "creationDateTime": string,
  "startDateTime": string,
  "completionDateTime": string,
  "estimatedCompletionRatio": number,
  "operationCount": string,
  "executedOperationCount": string,
  "executionLimitSeconds": integer
}
Felder
creationDateTime

string

Nur Ausgabe. Die Uhrzeit, zu der dieser Batchjob erstellt wurde. Formatiert als TT.MM.JJJJ HH:MM:SS. Beispiel: „2018-03-05 09:15:00“

startDateTime

string

Nur Ausgabe. Der Zeitpunkt, zu dem dieser Batchjob gestartet wurde. Formatiert als TT.MM.JJJJ HH:MM:SS. Beispiel: „2018-03-05 09:15:30“

completionDateTime

string

Nur Ausgabe. Die Uhrzeit, zu der dieser Batchjob abgeschlossen wurde. Formatiert als TT.MM.JJJJ HH:mm:ss. Beispiel: „2018-03-05 09:16:00“

estimatedCompletionRatio

number

Nur Ausgabe. Der Bruchteil (zwischen 0,0 und 1,0) der verarbeiteten Mutationen. Dieses Feld ist leer, wenn der Job noch nicht gestartet wurde.

operationCount

string (int64 format)

Nur Ausgabe. Die Anzahl der Mutaionsvorgänge im Batchjob.

executedOperationCount

string (int64 format)

Nur Ausgabe. Die Anzahl der Mutate-Vorgänge, die vom Batchjob ausgeführt werden. Nur vorhanden, wenn der Job gestartet wurde.

executionLimitSeconds

integer

Nicht veränderbar. Die ungefähre Obergrenze für die Dauer, in der ein Batchjob ausgeführt werden kann, in Sekunden. Wenn der Job länger als die angegebene Obergrenze ausgeführt wird, wird er abgebrochen.

BatchJobStatus

Die Status der Batchjobs.

Enums
UNSPECIFIED Nicht angegeben.
UNKNOWN Wird nur für den Rückgabewert verwendet. Stellt den Wert „Unbekannt“ in dieser Version dar.
PENDING Der Job wird derzeit nicht ausgeführt.
RUNNING Der Job wird ausgeführt.
DONE Der Job ist abgeschlossen.