משאב: HttpBody
הודעה שמייצגת גוף HTTP שרירותי. צריך להשתמש בו רק לפורמטים של מטען ייעודי (payload) שאי אפשר לייצג כ-JSON, כמו קובץ בינארי גולמי או דף HTML.
אפשר להשתמש בהודעה הזו גם בשיטות API של סטרימינג וגם בשיטות API שלא קשורות לסטרימינג, בבקשה וגם בתגובה.
אפשר להשתמש בו כשדה בקשה ברמה העליונה, וזה נוח אם רוצים לחלץ פרמטרים מכתובת ה-URL או מתבנית ה-HTTP לשדות הבקשה, וגם רוצים גישה לגוף ה-HTTP הגולמי.
דוגמה:
message GetResourceRequest {
// A unique request id.
string requestId = 1;
// The raw HTTP body is bound to this field.
google.api.HttpBody httpBody = 2;
}
service ResourceService {
rpc GetResource(GetResourceRequest)
returns (google.api.HttpBody);
rpc UpdateResource(google.api.HttpBody)
returns (google.protobuf.Empty);
}
דוגמה עם שיטות סטרימינג:
service CaldavService {
rpc GetCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
rpc UpdateCalendar(stream google.api.HttpBody)
returns (stream google.api.HttpBody);
}
השימוש בסוג הזה משנה רק את אופן הטיפול בגוף הבקשה והתגובה, כל שאר התכונות ימשיכו לפעול ללא שינוי.
| ייצוג ב-JSON |
|---|
{ "contentType": string, "data": string, "extensions": [ { "@type": string, field1: ..., ... } ] } |
| שדות | |
|---|---|
contentType |
ערך הכותרת Content-Type של HTTP שמציין את סוג התוכן של גוף הבקשה. |
data |
גוף בקשת HTTP/תגובת HTTP כקובץ בינארי גולמי. מחרוזת בקידוד Base64. |
extensions[] |
מטא-נתונים של תשובה ספציפית לאפליקציה. צריך להגדיר את השדה בתגובה הראשונה לממשקי API של סטרימינג. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף, |
Methods |
|
|---|---|
|
יוצרת תצוגת Iceberg במרחב השמות. |
|
מחיקת תצוגה במרחב השמות. |
|
מקבל תצוגה במרחב השמות. |
|
הפונקציה מחזירה את הערך 204 אם התצוגה קיימת, ואת הערך 404 אם לא. |
|
מציגה מזהי תצוגות (לא תצוגות) במרחב השמות. |
|
מעדכנת תצוגה במרחב השמות. |