Method: projects.locations.dataAgents.patch

עדכון הפרמטרים של DataAgent יחיד.

בקשת HTTP


PATCH https://geminidataanalytics.googleapis.com/v1alpha/{dataAgent.name=projects/*/locations/*/dataAgents/*}

כתובות ה-URL כתובות בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
dataAgent.name

string

זה שינוי אופציונלי. מזהה. שם המשאב הייחודי של DataAgent. פורמט: projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} הוא מזהה המשאב, צריך להיות באורך של 63 תווים או פחות, ולהתאים לפורמט שמתואר בכתובת https://google.aip.dev/122#resource-id-segments

דוגמה: projects/1234567890/locations/global/dataAgents/my-agent

מומלץ לדלג על הגדרת השדה הזה במהלך יצירת הסוכן, כי הוא יוסק באופן אוטומטי ויוחלף בערך {parent}/dataAgents/{dataAgentId}.

פרמטרים של שאילתה

פרמטרים
updateMask

string (FieldMask format)

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

זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"
requestId

string

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

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

מזהה הבקשה צריך להיות מזהה ייחודי אוניברסלי (UUID) תקין, למעט מזהה UUID אפס שלא נתמך (00000000-0000-0000-0000-000000000000).

גוף הבקשה

גוף הבקשה מכיל מופע של DataAgent.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Operation.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • geminidataanalytics.dataAgents.update

מידע נוסף מופיע במאמרי העזרה בנושא IAM.