REST Resource: projects.locations.dataStores.branches.documents

משאב: מסמך

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

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "schemaId": string,
  "content": {
    object (Content)
  },
  "parentDocumentId": string,
  "derivedStructData": {
    object
  },
  "aclInfo": {
    object (AclInfo)
  },
  "indexTime": string,
  "indexStatus": {
    object (IndexStatus)
  },

  // Union field data can be only one of the following:
  "structData": {
    object
  },
  "jsonData": string
  // End of list of possible types for union field data.
}
שדות
name

string

אי אפשר לשנות. השם המלא של המשאב של המסמך. פורמט: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}

השדה הזה חייב להיות מחרוזת בקידוד UTF-8, עם מגבלת אורך של 1,024 תווים.
id

string

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

המזהה צריך להיות בהתאם לתקן RFC-1034, עם מגבלת אורך של 128 תווים.
schemaId

string

המזהה של הסכימה שנמצאת באותו מאגר נתונים.
content

object (Content)

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

string

המזהה של מסמך האב. כרגע יש תמיכה בהיררכיית מסמכים עם שתי רמות לכל היותר.

המזהה צריך להיות בהתאם לתקן RFC-1034, עם מגבלת אורך של 63 תווים.
derivedStructData

object (Struct format)

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

object (AclInfo)

מידע על בקרת הגישה למסמך.
indexTime

string (Timestamp format)

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

השדה הזה הוא OUTPUT_ONLY. אם השדה הזה לא מאוכלס, זה אומר שהמסמך מעולם לא נוסף לאינדקס.

הפורמט הוא 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".
indexStatus

object (IndexStatus)

פלט בלבד. סטטוס האינדקס של המסמך.

  • אם המסמך נוסף לאינדקס בהצלחה, השדה indexTime יאוכלס.
  • אחרת, אם המסמך לא נוסף לאינדקס בגלל שגיאות, השדה errorSamples יאוכלס.
  • אחרת, אם מתבצעת יצירת אינדקס של המסמך, השדה pendingMessage מאוכלס.
שדה איחוד data. ייצוג נתונים. צריך לציין את אחד מהערכים struct_data או json_data, אחרת מוצגת שגיאה INVALID_ARGUMENT. הערך data יכול להיות רק אחד מהבאים:
structData

object (Struct format)

נתוני ה-JSON המובְנים של המסמך. הערך צריך להיות תואם לערך הרשום Schema, אחרת מוצגת שגיאת INVALID_ARGUMENT.
jsonData

string

ייצוג מחרוזת ה-JSON של המסמך. הערך צריך להיות תואם לערך הרשום Schema, אחרת מוצגת שגיאת INVALID_ARGUMENT.

Methods

create

 יצירת Document.

delete

 מחיקת Document.

get

 הפונקציה מחזירה Document.

getProcessedDocument

 קבלת מידע על הפריסה המנותחת של Document.

import

 ייבוא בכמות גדולה של כמה Document.

list

 מקבל רשימה של Document.

patch

 עדכון של Document.

purge

 מחיקה סופית של כל Document שנבחרו בהסתעפות.