משאב: משרה
תיאור של משימת פעולות אצווה באחסון.
| ייצוג ב-JSON |
|---|
{ "name": string, "description": string, "loggingConfig": { object ( |
| שדות | |
|---|---|
name |
מזהה. שם המשאב של המשרה. פורמט: לדוגמה: |
description |
זה שינוי אופציונלי. תיאור שהמשתמש סיפק למשימה. אורך מקסימלי: 1,024 בייטים בקידוד Unicode. |
loggingConfig |
זה שינוי אופציונלי. הגדרות רישום ביומן. |
createTime |
פלט בלבד. השעה שבה נוצרה העבודה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
scheduleTime |
פלט בלבד. השעה שבה המשימה תוכננה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
completeTime |
פלט בלבד. השעה שבה העבודה הושלמה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: |
counters |
פלט בלבד. מידע על התקדמות העבודה. |
errorSummaries[] |
פלט בלבד. סיכום של השגיאות שנתקלו בהן עם רשומות לדוגמה ביומן השגיאות. |
state |
פלט בלבד. המצב של העבודה. |
שדה איחוד source. מציינים את האובייקטים שרוצים לבצע בהם טרנספורמציה. הערך source יכול להיות רק אחד מהבאים: |
|
bucketList |
מציין רשימה של קטגוריות והאובייקטים שלהן שצריך לבצע בהם טרנספורמציה. |
שדה איחוד transformation. הפעולה שתתבצע על האובייקטים. הערך transformation יכול להיות רק אחד מהבאים: |
|
putObjectHold |
שינוי סטטוס דגל object hold של אובייקט. |
deleteObject |
מחיקת אובייקטים. |
putMetadata |
עדכון המטא-נתונים של האובייקט. מאפשר לעדכן מטא-נתונים עם מפתח קבוע ומטא-נתונים בהתאמה אישית. לדוגמה, |
rewriteObject |
הכתיבה מחדש של האובייקט ועדכון המטא-נתונים כמו מפתח KMS. |
BucketList
מתאר רשימה של קטגוריות ואת האובייקטים שלהן שצריך לבצע להם טרנספורמציה.
| ייצוג ב-JSON |
|---|
{
"buckets": [
{
object ( |
| שדות | |
|---|---|
buckets[] |
חובה. רשימה של קטגוריות והאובייקטים שלהן שצריך לבצע בהם טרנספורמציה. אפשר לציין רק קטגוריה אחת לכל עבודה. אם מציינים כמה קטגוריות, מתרחשת שגיאה. |
קטגוריה
מתאר את ההגדרה של דלי יחיד והאובייקטים שלו שצריך לבצע בהם טרנספורמציה.
| ייצוג ב-JSON |
|---|
{ "bucket": string, // Union field |
| שדות | |
|---|---|
bucket |
חובה. שם הקטגוריה של האובייקטים שרוצים לשנות. |
שדה איחוד object_configuration. מציינים את האובייקטים שרוצים לבצע בהם טרנספורמציה. הערך object_configuration יכול להיות רק אחד מהבאים: |
|
prefixList |
מציין אובייקטים שתואמים לקידומת שהוגדרה. |
manifest |
מציין אובייקטים בקובץ מניפסט. |
PrefixList
מתאר את הקידומות של האובייקטים שרוצים לבצע להם טרנספורמציה.
| ייצוג ב-JSON |
|---|
{ "includedObjectPrefixes": [ string ] } |
| שדות | |
|---|---|
includedObjectPrefixes[] |
זה שינוי אופציונלי. מציינים קידומת אובייקט אחת או יותר. לדוגמה:
|
מניפסט
מתאר רשימה של אובייקטים שצריך לבצע בהם טרנספורמציה.
| ייצוג ב-JSON |
|---|
{ "manifestLocation": string } |
| שדות | |
|---|---|
manifestLocation |
חובה. מציינים את המיקום של קובץ המניפסט, לדוגמה, הקובץ צריך לכלול שורת כותרת בפורמט הבא: הערה: בקובץ המניפסט צריך לציין רק אובייקטים בתוך הקטגוריה שסופקה למשימה. המערכת מתעלמת משורות שמפנות לאובייקטים בקטגוריות אחרות. |
PutObjectHold
מתאר אפשרויות לעדכון של דגל object hold.
| ייצוג ב-JSON |
|---|
{ "temporaryHold": enum ( |
| שדות | |
|---|---|
temporaryHold |
חובה. עדכון המצב של השהיה זמנית באובייקט. כשמוגדרת החזקה זמנית של אובייקט, אי אפשר למחוק או להחליף את האובייקט. |
eventBasedHold |
חובה. עדכון של מצב ההשהיות מבוססות-אירועים באובייקט. כשמוגדרת החזקה מבוססת-אירועים של אובייקט, אי אפשר למחוק או להחליף את האובייקט. מאפס את הזמן של האובייקט בקטגוריה למטרות תקופת השמירה. |
HoldStatus
תיאור הסטטוס של ההקפאה.
| טיפוסים בני מנייה (enum) | |
|---|---|
HOLD_STATUS_UNSPECIFIED |
ערך ברירת המחדל. סטטוס דגל object hold לא משתנה. |
SET |
מבצע את ההחזקה. |
UNSET |
ההחזקה תבוטל. |
DeleteObject
מתאר אפשרויות למחיקת אובייקט.
| ייצוג ב-JSON |
|---|
{ "permanentObjectDeletionEnabled": boolean } |
| שדות | |
|---|---|
permanentObjectDeletionEnabled |
חובה. המדיניות הזו קובעת את התנהגות המחיקה כשניהול הגרסאות מופעל בקטגוריה של האובייקט. אם הערך הוא true, גם אובייקטים פעילים וגם אובייקטים לא עדכניים יימחקו באופן סופי. אחרת, אובייקטים פעילים בקטגוריות עם ניהול גרסאות יהפכו ללא עדכניים, ואובייקטים שכבר היו לא עדכניים יידלגו. להגדרה הזו אין השפעה על התכונה 'מחיקה זמנית'. אם האפשרות הזו מופעלת, אפשר לשחזר את כל האובייקטים שנמחקו על ידי השירות הזה למשך תקופת השמירה של המחיקה הרכה. אם האפשרות הזו מופעלת ובקובץ המניפסט לא מצוין דור של אובייקט, מתבצעת קריאה של |
PutMetadata
מתוארות אפשרויות לעדכון המטא-נתונים של אובייקט.
| ייצוג ב-JSON |
|---|
{
"customMetadata": {
string: string,
...
},
"contentDisposition": string,
"contentEncoding": string,
"contentLanguage": string,
"contentType": string,
"cacheControl": string,
"customTime": string
"objectRetention": {
object ( |
| שדות | |
|---|---|
customMetadata |
זה שינוי אופציונלי. עדכון המטא-נתונים המותאמים אישית של האובייקט. הפעולה הזו מוסיפה או מגדירה צמדי מפתח/ערך של מטא-נתונים בהתאמה אישית. הערכים של מפתחות שצוינו עם ערכים ריקים יימחקו. מפתחות קיימים של מטא נתונים מותאמים אישית שלא נכללים בבקשה לא משתנים. פרטים נוספים מופיעים במאמר בנושא מטא-נתונים מותאמים אישית. אובייקט שמכיל רשימה של |
contentDisposition |
זה שינוי אופציונלי. עדכון אובייקטים |
contentEncoding |
זה שינוי אופציונלי. עדכון המטא-נתונים הקבועים של האובייקטים |
contentLanguage |
זה שינוי אופציונלי. מעדכן את המטא-נתונים של שפת התוכן הקבוע של האובייקטים. ערכי המטא-נתונים חייבים להיות קודי שפה לפי תקן ISO 639-1. האורך המקסימלי של ערכי מטא-נתונים הוא 100 תווים. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. פרטים נוספים זמינים במאמר בנושא Content-Language. |
contentType |
זה שינוי אופציונלי. עדכון אובייקטים |
cacheControl |
זה שינוי אופציונלי. עדכון המטא-נתונים הקבועים של האובייקטים |
customTime |
זה שינוי אופציונלי. עדכון המטא-נתונים של האובייקט שקשורים לזמן מותאם אישית קבוע. המערכת מתעלמת מערכים לא מוגדרים בבקשה. כדי לנקות את המטא-נתונים, מגדירים ערך ריק. פרטים נוספים מופיעים במאמר בנושא Custom-Time. |
objectRetention |
זה שינוי אופציונלי. עדכון הגדרת השמירה של אובייקט. המערכת מתעלמת מערכים שלא הוגדרו. כדי לבטל את השמירה של אובייקט, המאפיין |
ObjectRetention
מתאר את הגדרות השמירה של האובייקט.
| ייצוג ב-JSON |
|---|
{
"retainUntilTime": string,
"retentionMode": enum ( |
| שדות | |
|---|---|
retainUntilTime |
חובה. זמן התפוגה של שמירת הנתונים של האובייקט, שבמהלכו האובייקט מוגן מפני מחיקה או החלפה. השעה צריכה להיות בפורמט RFC 3339, לדוגמה |
retentionMode |
חובה. מצב השמירה. |
RetentionMode
מצב השמירה.
| טיפוסים בני מנייה (enum) | |
|---|---|
RETENTION_MODE_UNSPECIFIED |
לא צוין מצב השמירה. |
LOCKED |
אם מצב השמירה הוא LOCKED, אי אפשר להסיר את retainUntilTime או לקצר את תקופת השמירה. |
UNLOCKED |
כשמצב השמירה הוא UNLOCKED, אפשר להסיר או לשנות את retainUntilTime. |
RewriteObject
מתאר אפשרויות לכתיבה מחדש של אובייקטים.
| ייצוג ב-JSON |
|---|
{ "kmsKey": string } |
| שדות | |
|---|---|
kmsKey |
חובה. שם המשאב של מפתח Cloud KMS שמשמש להצפנת האובייקט. המפתח של Cloud KMS צריך להיות באותו מיקום שבו נמצא האובייקט. מידע נוסף זמין במאמר בנושא הצפנת אובייקט באמצעות מפתח Cloud KMS פורמט: לדוגמה: |
LoggingConfig
המדיניות קובעת את ההתנהגות של Cloud Logging.
| ייצוג ב-JSON |
|---|
{ "logActions": [ enum ( |
| שדות | |
|---|---|
logActions[] |
חובה. מציינים את הפעולות שיירשמו ביומן. |
logActionStates[] |
חובה. מדינות שבהן הפעולות נרשמות ביומן. אם הוא ריק, לא נוצרים יומנים. |
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 |
פלט בלבד. מספר האובייקטים שמופיעים ברשימה. |
succeededObjectCount |
פלט בלבד. מספר האובייקטים שהושלמו. |
failedObjectCount |
פלט בלבד. מספר האובייקטים שההעברה שלהם נכשלה. |
ErrorSummary
סיכום של השגיאות לפי קוד שגיאה, בנוסף לספירה ולדוגמאות של רשומות ביומן השגיאות.
| ייצוג ב-JSON |
|---|
{ "errorCode": enum ( |
| שדות | |
|---|---|
errorCode |
חובה. קוד השגיאה הקנוני. |
errorCount |
חובה. מספר השגיאות שהכלי נתקל בהן לכל |
errorLogEntries[] |
חובה. יומני שגיאות לדוגמה. |
קוד
הגדרת קודי שגיאה שמשמשים לטיפול בתגובות של 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 |
שגיאה לא ידועה. לדוגמה, יכול להיות שהשגיאה הזו תוחזר כשערך מיפוי HTTP: 500 שגיאת שרת פנימית |
INVALID_ARGUMENT |
הלקוח ציין ארגומנט לא חוקי. שימו לב שיש הבדל בין המאפיין הזה לבין מיפוי HTTP: 400 Bad Request |
DEADLINE_EXCEEDED |
המועד האחרון חלף לפני שהפעולה הסתיימה. בפעולות שמשנות את מצב המערכת, יכול להיות שהשגיאה הזו תוחזר גם אם הפעולה הושלמה בהצלחה. לדוגמה, יכול להיות שהתגובה המוצלחת משרת התגובות התעכבה מספיק זמן עד שהמועד האחרון חלף. מיפוי HTTP: 504 Gateway Timeout |
NOT_FOUND |
לא נמצאה ישות מבוקשת (לדוגמה, קובץ או ספרייה). הערה למפתחי שרתים: אם בקשה נדחית עבור קבוצה שלמה של משתמשים, למשל בהשקה הדרגתית של תכונה או ברשימת היתרים לא מתועדת, אפשר להשתמש ב- מיפוי HTTP: 404 לא נמצא |
ALREADY_EXISTS |
הישות שהלקוח ניסה ליצור (לדוגמה, קובץ או ספרייה) כבר קיימת. מיפוי HTTP: 409 Conflict |
PERMISSION_DENIED |
למתקשר אין הרשאה לבצע את הפעולה שצוינה. אסור להשתמש בערך מיפוי HTTP: 403 Forbidden |
UNAUTHENTICATED |
בבקשה לא צוינו פרטי כניסה תקפים לאימות לצורך הפעולה. מיפוי HTTP: 401 Unauthorized (אין הרשאה) |
RESOURCE_EXHAUSTED |
אזל המשאב, אולי מכסת משאבים לכל משתמש, או שאולי אין יותר מקום במערכת הקבצים. מיפוי HTTP: 429 Too Many Requests |
FAILED_PRECONDITION |
הפעולה נדחתה כי המערכת לא נמצאת במצב שנדרש לביצוע הפעולה. לדוגמה, הספרייה שרוצים למחוק לא ריקה, או שפעולת rmdir מוחלת על פריט שהוא לא ספרייה וכו'. מיישמי שירותים יכולים להשתמש בהנחיות הבאות כדי להחליט בין
מיפוי HTTP: 400 Bad Request |
ABORTED |
הפעולה בוטלה, בדרך כלל בגלל בעיה של פעולות מקבילות, כמו כשל בבדיקת רצף או ביטול עסקה. בהנחיות שלמעלה מוסבר איך קובעים מהו השיוך המתאים ביותר מבין מיפוי HTTP: 409 Conflict |
OUT_OF_RANGE |
הניסיון לבצע את הפעולה היה אחרי הטווח התקף. לדוגמה, חיפוש או קריאה אחרי סוף הקובץ. בניגוד לשגיאה יש חפיפה לא קטנה בין מיפוי HTTP: 400 Bad Request |
UNIMPLEMENTED |
הפעולה לא יושמה או שהיא לא אפשרית או לא מופעלת בשירות הזה. מיפוי HTTP: 501 Not Implemented |
INTERNAL |
שגיאות פנימיות. המשמעות היא שחלק מהכללים הקבועים שהמערכת הבסיסית מצפה להם נשברו. קוד השגיאה הזה שמור לשגיאות חמורות. מיפוי HTTP: 500 שגיאת שרת פנימית |
UNAVAILABLE |
השירות הזה לא זמין כרגע. הסיבה היא כנראה מצב זמני, שאפשר לתקן אותו על ידי ניסיון חוזר עם השהיה. חשוב לזכור שלא תמיד בטוח לנסות שוב פעולות שהן לא אידמפוטנטיות. בהנחיות שלמעלה מוסבר איך קובעים מהו השיוך המתאים ביותר מבין מיפוי HTTP: 503 השירות לא זמין |
DATA_LOSS |
פגם בנתונים או אובדן נתונים שלא ניתן לשחזר. מיפוי HTTP: 500 שגיאת שרת פנימית |
ErrorLogEntry
רשומה שמתארת שגיאה שאירעה.
| ייצוג ב-JSON |
|---|
{ "objectUri": string, "errorDetails": [ string ] } |
| שדות | |
|---|---|
objectUri |
חובה. פלט בלבד. כתובת ה-URL של האובייקט. לדוגמה, |
errorDetails[] |
זה שינוי אופציונלי. פלט בלבד. המערכת מתעדת עד 5 רשומות ביומן השגיאות לכל קוד שגיאה בכל משימה. |
מדינה
תיאור המצב של משרה.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
RUNNING |
בתהליך. |
SUCCEEDED |
הפעולה הושלמה בהצלחה. |
CANCELED |
בוטלה על ידי המשתמש. |
FAILED |
התהליך הסתיים בגלל כשל שלא ניתן לשחזר. |
Methods |
|
|---|---|
|
ביטול של משימה באצווה בפרויקט נתון במיקום נתון. |
|
יוצר משימה באצווה בפרויקט נתון במיקום נתון. |
|
מחיקת משימת אצווה בפרויקט נתון במיקום נתון. |
|
מקבלים משימה באצווה בפרויקט נתון במיקום נתון. |
|
מציגה רשימה של כל עבודות ה-Batch בפרויקט מסוים במיקום מסוים. |