REST Resource: projects.locations.jobs

משאב: משרה

תיאור של משימת פעולות אצווה באחסון.

ייצוג ב-JSON
{
  "name": string,
  "description": string,
  "loggingConfig": {
    object (LoggingConfig)
  },
  "createTime": string,
  "scheduleTime": string,
  "completeTime": string,
  "counters": {
    object (Counters)
  },
  "errorSummaries": [
    {
      object (ErrorSummary)
    }
  ],
  "state": enum (State),

  // Union field source can be only one of the following:
  "bucketList": {
    object (BucketList)
  }
  // End of list of possible types for union field source.

  // Union field transformation can be only one of the following:
  "putObjectHold": {
    object (PutObjectHold)
  },
  "deleteObject": {
    object (DeleteObject)
  },
  "putMetadata": {
    object (PutMetadata)
  },
  "rewriteObject": {
    object (RewriteObject)
  }
  // End of list of possible types for union field transformation.
}
שדות
name

string

מזהה. שם המשאב של המשרה.

פורמט: projects/{project}/locations/global/jobs/{jobId}

לדוגמה: projects/123456/locations/global/jobs/job01.

jobId הוא ייחודי בפרויקט נתון למיקום נתון. אם לא מציינים את jobId, מוקצה מזהה שנוצר על ידי השרת.

description

string

זה שינוי אופציונלי. תיאור שהמשתמש סיפק למשימה.

אורך מקסימלי: 1,024 בייטים בקידוד Unicode.

loggingConfig

object (LoggingConfig)

זה שינוי אופציונלי. הגדרות רישום ביומן.

createTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצרה העבודה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

scheduleTime

string (Timestamp format)

פלט בלבד. השעה שבה המשימה תוכננה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

completeTime

string (Timestamp format)

פלט בלבד. השעה שבה העבודה הושלמה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".

counters

object (Counters)

פלט בלבד. מידע על התקדמות העבודה.

errorSummaries[]

object (ErrorSummary)

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

state

enum (State)

פלט בלבד. המצב של העבודה.

שדה איחוד source. מציינים את האובייקטים שרוצים לבצע בהם טרנספורמציה. הערך source יכול להיות רק אחד מהבאים:
bucketList

object (BucketList)

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

שדה איחוד transformation. הפעולה שתתבצע על האובייקטים. הערך transformation יכול להיות רק אחד מהבאים:
putObjectHold

object (PutObjectHold)

שינוי סטטוס דגל object hold של אובייקט.

deleteObject

object (DeleteObject)

מחיקת אובייקטים.

putMetadata

object (PutMetadata)

עדכון המטא-נתונים של האובייקט. מאפשר לעדכן מטא-נתונים עם מפתח קבוע ומטא-נתונים בהתאמה אישית. לדוגמה, Cache-Control,‏ Content-Disposition,‏ Content-Encoding,‏ Content-Language,‏ Content-Type,‏ Custom-Time ו-object retention.

rewriteObject

object (RewriteObject)

הכתיבה מחדש של האובייקט ועדכון המטא-נתונים כמו מפתח KMS.

BucketList

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

ייצוג ב-JSON
{
  "buckets": [
    {
      object (Bucket)
    }
  ]
}
שדות
buckets[]

object (Bucket)

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

קטגוריה

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

ייצוג ב-JSON
{
  "bucket": string,

  // Union field object_configuration can be only one of the following:
  "prefixList": {
    object (PrefixList)
  },
  "manifest": {
    object (Manifest)
  }
  // End of list of possible types for union field object_configuration.
}
שדות
bucket

string

חובה. שם הקטגוריה של האובייקטים שרוצים לשנות.

שדה איחוד object_configuration. מציינים את האובייקטים שרוצים לבצע בהם טרנספורמציה. הערך object_configuration יכול להיות רק אחד מהבאים:
prefixList

object (PrefixList)

מציין אובייקטים שתואמים לקידומת שהוגדרה.

manifest

object (Manifest)

מציין אובייקטים בקובץ מניפסט.

PrefixList

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

ייצוג ב-JSON
{
  "includedObjectPrefixes": [
    string
  ]
}
שדות
includedObjectPrefixes[]

string

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

  • כדי לבצע התאמה לאובייקט אחד, משתמשים בתחילית אחת, prefix1.

  • כדי להתאים לכמה אובייקטים, משתמשים בקידומות מופרדות בפסיקים, prefix1,prefix2.

  • כדי להתאים את כל האובייקטים, משתמשים בתחילית ריקה,''

מניפסט

מתאר רשימה של אובייקטים שצריך לבצע בהם טרנספורמציה.

ייצוג ב-JSON
{
  "manifestLocation": string
}
שדות
manifestLocation

string

חובה. מציינים את המיקום של קובץ המניפסט, לדוגמה, gs://bucket_name/path/object_name.csv. קובץ המניפסט הוא קובץ CSV שמועלה ל-Cloud Storage ומכיל אובייקט אחד או רשימה של אובייקטים שרוצים לעבד. כל שורה במניפסט חייבת לכלול את bucket ו-name של האובייקט. אפשר גם לציין את generation של האובייקט. אם לא מציינים את generation, נעשה שימוש בגרסה הנוכחית של האובייקט.

הקובץ צריך לכלול שורת כותרת בפורמט הבא: bucket,name,generation. העמודה generation היא אופציונלית. לדוגמה,

bucket,name,generation
bucket_1,object_1,generation_1
bucket_1,object_2,generation_2
bucket_1,object_3,generation_3

הערה: בקובץ המניפסט צריך לציין רק אובייקטים בתוך הקטגוריה שסופקה למשימה. המערכת מתעלמת משורות שמפנות לאובייקטים בקטגוריות אחרות.

PutObjectHold

מתאר אפשרויות לעדכון של דגל object hold.

ייצוג ב-JSON
{
  "temporaryHold": enum (HoldStatus),
  "eventBasedHold": enum (HoldStatus)
}
שדות
temporaryHold

enum (HoldStatus)

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

eventBasedHold

enum (HoldStatus)

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

HoldStatus

תיאור הסטטוס של ההקפאה.

טיפוסים בני מנייה (enum)
HOLD_STATUS_UNSPECIFIED ערך ברירת המחדל. סטטוס דגל object hold לא משתנה.
SET מבצע את ההחזקה.
UNSET ההחזקה תבוטל.

DeleteObject

מתאר אפשרויות למחיקת אובייקט.

ייצוג ב-JSON
{
  "permanentObjectDeletionEnabled": boolean
}
שדות
permanentObjectDeletionEnabled

boolean

חובה. המדיניות הזו קובעת את התנהגות המחיקה כשניהול הגרסאות מופעל בקטגוריה של האובייקט. אם הערך הוא true, גם אובייקטים פעילים וגם אובייקטים לא עדכניים יימחקו באופן סופי. אחרת, אובייקטים פעילים בקטגוריות עם ניהול גרסאות יהפכו ללא עדכניים, ואובייקטים שכבר היו לא עדכניים יידלגו. להגדרה הזו אין השפעה על התכונה 'מחיקה זמנית'. אם האפשרות הזו מופעלת, אפשר לשחזר את כל האובייקטים שנמחקו על ידי השירות הזה למשך תקופת השמירה של המחיקה הרכה. אם האפשרות הזו מופעלת ובקובץ המניפסט לא מצוין דור של אובייקט, מתבצעת קריאה של GetObjectMetadata כדי לקבוע את הדור של האובייקט הפעיל.

PutMetadata

מתוארות אפשרויות לעדכון המטא-נתונים של אובייקט.

ייצוג ב-JSON
{
  "customMetadata": {
    string: string,
    ...
  },
  "contentDisposition": string,
  "contentEncoding": string,
  "contentLanguage": string,
  "contentType": string,
  "cacheControl": string,
  "customTime": string
  "objectRetention": {
    object (ObjectRetention)
  }
}
שדות
customMetadata

map (key: string, value: string)

זה שינוי אופציונלי. עדכון המטא-נתונים המותאמים אישית של האובייקט. הפעולה הזו מוסיפה או מגדירה צמדי מפתח/ערך של מטא-נתונים בהתאמה אישית. הערכים של מפתחות שצוינו עם ערכים ריקים יימחקו. מפתחות קיימים של מטא נתונים מותאמים אישית שלא נכללים בבקשה לא משתנים. פרטים נוספים מופיעים במאמר בנושא מטא-נתונים מותאמים אישית.

אובייקט שמכיל רשימה של "key": "value" זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

contentDisposition

string

זה שינוי אופציונלי. עדכון אובייקטים Content-Disposition תיקון מטא-נתונים. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. פרטים נוספים זמינים במאמר בנושא Content-Disposition.

contentEncoding

string

זה שינוי אופציונלי. עדכון המטא-נתונים הקבועים של האובייקטים Content-Encoding. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. פרטים נוספים זמינים במאמר בנושא קידוד תוכן.

contentLanguage

string

זה שינוי אופציונלי. מעדכן את המטא-נתונים של שפת התוכן הקבוע של האובייקטים. ערכי המטא-נתונים חייבים להיות קודי שפה לפי תקן ISO 639-1. האורך המקסימלי של ערכי מטא-נתונים הוא 100 תווים. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. פרטים נוספים זמינים במאמר בנושא Content-Language.

contentType

string

זה שינוי אופציונלי. עדכון אובייקטים Content-Type תיקון מטא-נתונים. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. פרטים נוספים מופיעים במאמר בנושא Content-Type.

cacheControl

string

זה שינוי אופציונלי. עדכון המטא-נתונים הקבועים של האובייקטים Cache-Control. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. בנוסף, הערך של Custom-Time לא יכול לרדת. פרטים נוספים מופיעים במאמר בנושא Cache-Control.

customTime

string

זה שינוי אופציונלי. עדכון המטא-נתונים של האובייקט שקשורים לזמן מותאם אישית קבוע. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. פרטים נוספים מופיעים במאמר בנושא Custom-Time.

objectRetention

object (ObjectRetention)

זה שינוי אופציונלי. עדכון הגדרת השמירה של אובייקט. המערכת מתעלמת מערכים שלא הוגדרו. כדי לבטל את השמירה של אובייקט, המאפיין retentionMode צריך להיות במצב UNLOCKED והמאפיין retainUntilTime צריך להיות מוגדר כמחרוזת ריקה. אי אפשר למחוק את תקופת השמירה של אובייקט במצב שמירה LOCKED או לקצר אותה.retainUntilTime מידע נוסף זמין במאמר retainUntilTime.

ObjectRetention

מתאר את הגדרות השמירה של האובייקט.

ייצוג ב-JSON
{
  "retainUntilTime": string,
  "retentionMode": enum (RetentionMode)
}
שדות
retainUntilTime

string

חובה. זמן התפוגה של שמירת הנתונים של האובייקט, שבמהלכו האובייקט מוגן מפני מחיקה או החלפה. השעה צריכה להיות בפורמט RFC 3339, לדוגמה YYYY-MM-DD'T'HH:MM:SS.SS'Z'. כדי לבטל את השמירה של אובייקט, הערך של retentionMode צריך להיות UNLOCKED והערך של retainUntilTime צריך להיות מחרוזת ריקה.

retentionMode

enum (RetentionMode)

חובה. מצב השמירה.

RetentionMode

מצב השמירה.

טיפוסים בני מנייה (enum)
RETENTION_MODE_UNSPECIFIED לא צוין מצב השמירה.
LOCKED אם מצב השמירה הוא LOCKED, אי אפשר להסיר את retainUntilTime או לקצר את תקופת השמירה.
UNLOCKED כשמצב השמירה הוא UNLOCKED, אפשר להסיר או לשנות את retainUntilTime.

RewriteObject

מתאר אפשרויות לכתיבה מחדש של אובייקטים.

ייצוג ב-JSON
{
  "kmsKey": string
}
שדות
kmsKey

string

חובה. שם המשאב של מפתח Cloud KMS שמשמש להצפנת האובייקט. המפתח של Cloud KMS צריך להיות באותו מיקום שבו נמצא האובייקט. מידע נוסף זמין במאמר בנושא הצפנת אובייקט באמצעות מפתח Cloud KMS

פורמט: projects/{project}/locations/{locationid}/keyRings/{keyring}/cryptoKeys/{key}

לדוגמה: projects/123456/locations/us-central1/keyRings/my-keyring/cryptoKeys/my-key. האובייקט נכתב מחדש ומוגדר עם מפתח ה-KMS שצוין.

LoggingConfig

המדיניות קובעת את ההתנהגות של Cloud Logging.

ייצוג ב-JSON
{
  "logActions": [
    enum (LoggableAction)
  ],
  "logActionStates": [
    enum (LoggableActionState)
  ]
}
שדות
logActions[]

enum (LoggableAction)

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

logActionStates[]

enum (LoggableActionState)

חובה. מדינות שבהן הפעולות נרשמות ביומן. אם הוא ריק, לא נוצרים יומנים.

LoggableAction

סוגי פעולות שאפשר לרשום ביומן.

טיפוסים בני מנייה (enum)
LOGGABLE_ACTION_UNSPECIFIED ערך לא חוקי, כדי למנוע הגדרת ברירת מחדל.
TRANSFORM פעולת הטרנספורמציה התואמת בעבודה הזו.

LoggableActionState

מסנן של מצבי פעולה שניתן לרשום ביומן.

טיפוסים בני מנייה (enum)
LOGGABLE_ACTION_STATE_UNSPECIFIED ערך לא חוקי, כדי למנוע הגדרת ברירת מחדל.
SUCCEEDED LoggableAction הושלם בהצלחה. פעולות של SUCCEEDED מתועדות ביומן כ-‎[INFO][google.logging.type.LogSeverity.INFO]‎.
FAILED התהליך LoggableAction הסתיים במצב שגיאה. פעולות FAILED מתועדות ביומן כ-‎[ERROR][google.logging.type.LogSeverity.ERROR]‎.

מונים

תיאור של פרטים על התקדמות המשימה.

ייצוג ב-JSON
{
  "totalObjectCount": string,
  "succeededObjectCount": string,
  "failedObjectCount": string
}
שדות
totalObjectCount

string (int64 format)

פלט בלבד. מספר האובייקטים שמופיעים ברשימה.

succeededObjectCount

string (int64 format)

פלט בלבד. מספר האובייקטים שהושלמו.

failedObjectCount

string (int64 format)

פלט בלבד. מספר האובייקטים שההעברה שלהם נכשלה.

ErrorSummary

סיכום של השגיאות לפי קוד שגיאה, בנוסף לספירה ולדוגמאות של רשומות ביומן השגיאות.

ייצוג ב-JSON
{
  "errorCode": enum (Code),
  "errorCount": string,
  "errorLogEntries": [
    {
      object (ErrorLogEntry)
    }
  ]
}
שדות
errorCode

enum (Code)

חובה. קוד השגיאה הקנוני.

errorCount

string (int64 format)

חובה. מספר השגיאות שהכלי נתקל בהן לכל errorCode.

errorLogEntries[]

object (ErrorLogEntry)

חובה. יומני שגיאות לדוגמה.

קוד

הגדרת קודי שגיאה שמשמשים לטיפול בתגובות של gRPC API.

אם כמה קודי שגיאה רלוונטיים, צריך להחזיר את קוד השגיאה הספציפי ביותר. לדוגמה, אם שני הקודים חלים, עדיף להשתמש ב-OUT_OF_RANGE במקום ב-FAILED_PRECONDITION. באופן דומה, עדיף להשתמש ב-NOT_FOUND או ב-ALREADY_EXISTS במקום ב-FAILED_PRECONDITION.

טיפוסים בני מנייה (enum)
OK

מוחזר כשהפעולה מסתיימת בהצלחה.

מיפוי HTTP: ‏ 200 OK

CANCELLED

הפעולה בוטלה, בדרך כלל על ידי המתקשר.

מיפוי HTTP: ‏ 499 Client Closed Request

UNKNOWN

שגיאה לא ידועה. לדוגמה, יכול להיות שהשגיאה הזו תוחזר כשערך Status שמתקבל ממרחב כתובות אחר שייך למרחב שגיאות שלא מוכר במרחב הכתובות הזה. יכול להיות שגם שגיאות שמועלות על ידי ממשקי API שלא מחזירים מספיק מידע על השגיאה יומרו לשגיאה הזו.

מיפוי HTTP: ‏ 500 שגיאת שרת פנימית

INVALID_ARGUMENT

הלקוח ציין ארגומנט לא חוקי. שימו לב שיש הבדל בין המאפיין הזה לבין FAILED_PRECONDITION. INVALID_ARGUMENT מציין ארגומנטים בעייתיים ללא קשר למצב המערכת (לדוגמה, שם קובץ לא תקין).

מיפוי HTTP: ‏ 400 Bad Request

DEADLINE_EXCEEDED

המועד האחרון חלף לפני שהפעולה הסתיימה. בפעולות שמשנות את מצב המערכת, יכול להיות שהשגיאה הזו תוחזר גם אם הפעולה הושלמה בהצלחה. לדוגמה, יכול להיות שהתגובה המוצלחת משרת התגובות התעכבה מספיק זמן עד שהמועד האחרון חלף.

מיפוי HTTP: ‏ 504 Gateway Timeout

NOT_FOUND

לא נמצאה ישות מבוקשת (לדוגמה, קובץ או ספרייה).

הערה למפתחי שרתים: אם בקשה נדחית עבור קבוצה שלמה של משתמשים, למשל בהשקה הדרגתית של תכונה או ברשימת היתרים לא מתועדת, אפשר להשתמש ב-NOT_FOUND. אם בקשה נדחית עבור חלק מהמשתמשים בקבוצת משתמשים, כמו בקרת גישה מבוססת-משתמש, צריך להשתמש ב-PERMISSION_DENIED.

מיפוי HTTP: ‏ 404 לא נמצא

ALREADY_EXISTS

הישות שהלקוח ניסה ליצור (לדוגמה, קובץ או ספרייה) כבר קיימת.

מיפוי HTTP: ‏ ‎409 Conflict

PERMISSION_DENIED

למתקשר אין הרשאה לבצע את הפעולה שצוינה. אסור להשתמש בערך PERMISSION_DENIED לדחיות שנגרמות בגלל מיצוי של משאב מסוים (במקום זאת צריך להשתמש בערך RESOURCE_EXHAUSTED לשגיאות האלה). אסור להשתמש ב-PERMISSION_DENIED אם אי אפשר לזהות את המתקשר (במקרים כאלה צריך להשתמש ב-UNAUTHENTICATED). קוד השגיאה הזה לא מציין שהבקשה תקפה, שהישות המבוקשת קיימת או שהיא עומדת בתנאים מוקדמים אחרים.

מיפוי HTTP: ‏ 403 Forbidden

UNAUTHENTICATED

בבקשה לא צוינו פרטי כניסה תקפים לאימות לצורך הפעולה.

מיפוי HTTP: ‏ 401 Unauthorized (אין הרשאה)

RESOURCE_EXHAUSTED

אזל המשאב, אולי מכסת משאבים לכל משתמש, או שאולי אין יותר מקום במערכת הקבצים.

מיפוי HTTP: ‏ 429 Too Many Requests

FAILED_PRECONDITION

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

מיישמי שירותים יכולים להשתמש בהנחיות הבאות כדי להחליט בין FAILED_PRECONDITION,‏ ABORTED ו-UNAVAILABLE:

  • משתמשים ב-UNAVAILABLE אם הלקוח יכול לנסות שוב רק את השיחה שנכשלה.
  • משתמשים ב-ABORTED אם הלקוח צריך לנסות שוב ברמה גבוהה יותר. לדוגמה, כשבדיקה והגדרה שצוינו על ידי הלקוח נכשלות, מה שמצביע על כך שהלקוח צריך להפעיל מחדש רצף של קריאה, שינוי וכתיבה.
  • משתמשים ב-FAILED_PRECONDITION אם הלקוח לא צריך לנסות שוב עד שמצב המערכת יתוקן באופן מפורש. לדוגמה, אם הפקודה rmdir נכשלת כי הספרייה לא ריקה, צריך להחזיר את FAILED_PRECONDITION כי הלקוח לא צריך לנסות שוב אלא אם הקבצים נמחקים מהספרייה.

מיפוי HTTP: ‏ 400 Bad Request

ABORTED

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

בהנחיות שלמעלה מוסבר איך קובעים מהו השיוך המתאים ביותר מבין FAILED_PRECONDITION,‏ ABORTED ו-UNAVAILABLE.

מיפוי HTTP: ‏ ‎409 Conflict

OUT_OF_RANGE

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

בניגוד לשגיאה INVALID_ARGUMENT, השגיאה הזו מצביעה על בעיה שאולי תיפתר אם מצב המערכת ישתנה. לדוגמה, אם מערכת קבצים של 32 ביט תתבקש לקרוא נתונים בהיסט שלא נמצא בטווח [0,2^32-1], היא תיצור INVALID_ARGUMENT, אבל אם היא תתבקש לקרוא נתונים בהיסט שגדול מגודל הקובץ הנוכחי, היא תיצור OUT_OF_RANGE.

יש חפיפה לא קטנה בין FAILED_PRECONDITION לבין OUT_OF_RANGE. מומלץ להשתמש ב-OUT_OF_RANGE (השגיאה הספציפית יותר) כשהיא רלוונטית, כדי שמשתמשים שמתקשרים למרחב יוכלו לחפש בקלות שגיאת OUT_OF_RANGE כדי לדעת שהם סיימו.

מיפוי HTTP: ‏ 400 Bad Request

UNIMPLEMENTED

הפעולה לא יושמה או שהיא לא אפשרית או לא מופעלת בשירות הזה.

מיפוי HTTP: ‏ ‎501 Not Implemented

INTERNAL

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

מיפוי HTTP: ‏ 500 שגיאת שרת פנימית

UNAVAILABLE

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

בהנחיות שלמעלה מוסבר איך קובעים מהו השיוך המתאים ביותר מבין FAILED_PRECONDITION,‏ ABORTED ו-UNAVAILABLE.

מיפוי HTTP: ‏ 503 השירות לא זמין

DATA_LOSS

פגם בנתונים או אובדן נתונים שלא ניתן לשחזר.

מיפוי HTTP: ‏ 500 שגיאת שרת פנימית

ErrorLogEntry

רשומה שמתארת שגיאה שאירעה.

ייצוג ב-JSON
{
  "objectUri": string,
  "errorDetails": [
    string
  ]
}
שדות
objectUri

string

חובה. פלט בלבד. כתובת ה-URL של האובייקט. לדוגמה, gs://my_bucket/object.txt

errorDetails[]

string

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

מדינה

תיאור המצב של משרה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
RUNNING בתהליך.
SUCCEEDED הפעולה הושלמה בהצלחה.
CANCELED בוטלה על ידי המשתמש.
FAILED התהליך הסתיים בגלל כשל שלא ניתן לשחזר.

Methods

cancel

ביטול של משימה באצווה בפרויקט נתון במיקום נתון.

create

יוצר משימה באצווה בפרויקט נתון במיקום נתון.

delete

מחיקת משימת אצווה בפרויקט נתון במיקום נתון.

get

מקבלים משימה באצווה בפרויקט נתון במיקום נתון.

list

מציגה רשימה של כל עבודות ה-Batch בפרויקט מסוים במיקום מסוים.