Method: projects.databases.indexes.create

יצירת האינדקס שצוין. המצב הראשוני של אינדקס חדש שנוצר הוא CREATING. לאחר השלמת ההחזרה של google.longrunning.Operation, המצב יהיה READY. אם האינדקס כבר קיים, הקריאה תחזיר סטטוס ALREADY_EXISTS.

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

לא ניתן ליצור אינדקסים עם שדה אחד.

בקשת HTTP

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
parent

string

שם מסד הנתונים שעליו יחול האינדקס הזה. לדוגמה: projects/{projectId}/databases/{databaseId}

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין בסקירה הכללית על אימות.