BatchJob

רשימה של שינויים המעובדים באופן אסינכרוני. השינויים מועלים על ידי המשתמש. השינויים עצמם לא קריאים וניתן לקרוא את התוצאות של המשימה רק באמצעות BatchJobService.ListBatchJobResults.

ייצוג JSON 
{
  "resourceName": string,
  "metadata": {
    object (BatchJobMetadata)
  },
  "status": enum (BatchJobStatus),
  "id": string,
  "nextAddSequenceToken": string,
  "longRunningOperation": string
}
שדות
resourceName

string

בלתי משתנה. שם המשאב של המשימה באצווה. שמות המשאבים של משימות באצווה מופיעים בצורה הבאה:

customers/{customerId}/batchJobs/{batch_job_id}
metadata

object (BatchJobMetadata)

פלט בלבד. מכילה מידע נוסף על המשימה הזו באצווה.
status

enum (BatchJobStatus)

פלט בלבד. הסטטוס של המשימה הזו באצווה.
id

string (int64 format)

פלט בלבד. המזהה של משימת האצווה הזו.
nextAddSequenceToken

string

פלט בלבד. אסימון הרצף הבא לשימוש בעת הוספת פעולות. יש להגדיר רק כשהסטטוס של המשימה באצווה נמצא בהמתנה.
longRunningOperation

string

פלט בלבד. שם המשאב של הפעולה הממושכת, שיכול לשמש לבדיקה של השלמה. יש להגדיר רק כשהסטטוס של המשימה באצווה הוא RUNNING או DONE.

BatchJobMetadata

מידע נוסף על המשימה באצווה. ההודעה הזו משמשת גם כמטא-נתונים שהוחזרו במשימות ממושכות של משימות באצווה.

ייצוג JSON 
{
  "creationDateTime": string,
  "startDateTime": string,
  "completionDateTime": string,
  "estimatedCompletionRatio": number,
  "operationCount": string,
  "executedOperationCount": string,
  "executionLimitSeconds": integer
}
שדות
creationDateTime

string

פלט בלבד. השעה שבה נוצרה משימת האצווה הזו. בפורמט yyyy-mm-dd hh:mm:ss. לדוגמה: '2018-03-05 09:15:00'
startDateTime

string

פלט בלבד. השעה שבה משימת האצווה הזו התחילה לפעול. בפורמט yyyy-mm-dd hh:mm:ss. לדוגמה: '2018-03-05 09:15:30'
completionDateTime

string

פלט בלבד. השעה שבה הושלמה משימת האצווה הזו. בפורמט: yyyy-MM-dd HH:mm:ss. לדוגמה: 2018-03-05 09:16:00
estimatedCompletionRatio

number

פלט בלבד. השבר (בין 0.0 ל-1.0) של השינויים שעובדו. אם המשימה עדיין לא התחילה, השדה הזה ריק.
operationCount

string (int64 format)

פלט בלבד. מספר פעולות השינוי במשימת האצווה.
executedOperationCount

string (int64 format)

פלט בלבד. מספר פעולות השינוי שבוצעו על ידי משימת האצווה. להציג רק אם המשימה התחילה לפעול.
executionLimitSeconds

integer

בלתי משתנה. הגבול העליון המשוער של משך הזמן שבו ניתן לבצע משימת אצווה, בשניות. אם המשימה תחרוג מהגבול העליון הנתון, היא תבוטל.

BatchJobStatus

הסטטוסים של משימות באצווה.

טיפוסים בני מנייה (enums)
UNSPECIFIED לא צוין.
UNKNOWN משמש לציון הערך המוחזר בלבד. מייצג ערך לא ידוע בגרסה הזו.
PENDING המשימה לא פועלת כרגע.
RUNNING המשימה מתבצעת.
DONE המשימה הסתיימה.