Package google.firestore.admin.v1beta1

אינדקס

FirestoreAdmin

Cloud Firestore Admin API.

ה-API הזה מספק מספר שירותי ניהול ל-Cloud Firestore.

מושגים

פרויקט, מסד נתונים, מרחב שמות, אוסף ומסמך משמשים כפי שמוגדר ב-Google Cloud Firestore API.

פעולה: פעולה מייצגת עבודה המתבצעת ברקע.

שירותים

אינדקס

שירות האינדקס מנהל את האינדקסים של Cloud Firestore.

יצירת האינדקס מתבצעת באופן אסינכרוני. המערכת יוצרת משאב פעולה לכל פעולה אסינכרונית כזו. ניתן לבדוק את מצב הפעולה (כולל שגיאות שהתגלו) במשאב הפעולה.

מטא-נתונים

מטא-נתונים ומידע סטטיסטי על נתונים ב-Cloud Firestore. יכול להיות שהנתונים שמסופקים כחלק מה-API הזה לא פעילים.

פעולה

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

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

פעולה שבוצעה עשויה להימחק כדי שהיא לא תופיע יותר כחלק מאוסף הפעולות.

הפעולות נוצרות על ידי השירות FirestoreAdmin, אבל אפשר לגשת אליהן דרך השירות google.longrunning.Operations.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

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

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

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

היקפי הרשאות

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

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

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

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

מחיקת אינדקס.

היקפי הרשאות

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

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

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

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

ייצוא עותק של כל המסמכים או של קבוצת משנה שלהם מ-Google Cloud Firestore למערכת אחסון אחרת, כמו Google Cloud Storage. ייתכן שהעדכונים האחרונים במסמכים לא יבואו לידי ביטוי בייצוא. הייצוא מתרחש ברקע, ואפשר לעקוב אחר ההתקדמות שלו ולנהל אותה באמצעות משאב הפעולה שנוצר. אפשר להשתמש בפלט של ייצוא רק לאחר סיום הפעולה המשויכת. אם פעולת ייצוא מתבטלת לפני הסיום, היא עלולה להשאיר נתונים חלקיים ב-Google Cloud Storage.

היקפי הרשאות

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

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

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

rpc GetIndex(GetIndexRequest) returns (Index)

מקבלת אינדקס.

היקפי הרשאות

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

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

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

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

מייבאת מסמכים אל Google Cloud Firestore. מסמכים קיימים עם אותו שם יוחלפו. הייבוא מתבצע ברקע, וניתן לעקוב אחר ההתקדמות שלו ולנהל אותה באמצעות משאב הפעולה שנוצר. אם פעולת ImportDocuments בוטלה, יכול להיות שקבוצת משנה של הנתונים כבר יובאה אל Cloud Firestore.

היקפי הרשאות

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

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

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

רשימת האינדקסים שתואמים למסננים שצוינו.

היקפי הרשאות

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

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

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

CreateIndexRequest

הבקשה על FirestoreAdmin.CreateIndex.

שדות
parent

string

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

Index

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

DeleteIndexRequest

הבקשה על FirestoreAdmin.DeleteIndex.

שדות
name

string

שם האינדקס. לדוגמה: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

מטא-נתונים לפעולות ייצוא מסמכים.

שדות
start_time

Timestamp

השעה שבה התחילה העבודה על הפעולה.
end_time

Timestamp

השעה שבה הפעולה הסתיימה – בהצלחה או לא. יש לבטל את ההגדרה אם הפעולה עדיין פעילה.
operation_state

OperationState

המצב של פעולת הייצוא.
progress_documents

Progress

הערכה של מספר המסמכים שעובדו.
progress_bytes

Progress

הערכה של מספר הבייטים שעובדו.
collection_ids[]

string

אילו מזהי אוספים רוצים לייצא?
output_uri_prefix

string

היעד שאליו מתבצע ייצוא הישויות.

ExportDocumentsRequest

הבקשה על FirestoreAdmin.ExportDocuments.

שדות
name

string

מסד הנתונים לייצוא. הוא אמור להופיע בפורמט: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

אילו מזהי אוספים לייצא אם לא צוין אחרת, המשמעות היא כל האוספים.
output_uri_prefix

string

ה-URI של הפלט. נכון לעכשיו יש תמיכה במזהי URI של Google Cloud Storage בצורה הבאה: gs://BUCKET_NAME[/NAMESPACE_PATH], כאשר BUCKET_NAME הוא השם של הקטגוריה של Google Cloud Storage ו-NAMESPACE_PATH הוא נתיב אופציונלי של מרחב שמות ב-Google Cloud Storage. כשבוחרים שם, חשוב לפעול לפי ההנחיות למתן שמות ל-Google Cloud Storage: https://cloud.google.com/storage/docs/naming. אם ה-URI הוא קטגוריה (ללא נתיב מרחב שמות), תיווצר קידומת על סמך שעת ההתחלה.

ExportDocumentsResponse

הערך הוחזר בשדה התגובה google.longrunning.Operation.

שדות
output_uri_prefix

string

המיקום של קובצי הפלט. אפשר להשתמש בו כדי להתחיל לייבא ל-Cloud Firestore (הפרויקט הזה או פרויקט אחר) אחרי שהפעולה תסתיים בהצלחה.

GetIndexRequest

הבקשה על FirestoreAdmin.GetIndex.

שדות
name

string

שם האינדקס. לדוגמה: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

מטא-נתונים לפעולות של ImportDocuments.

שדות
start_time

Timestamp

השעה שבה התחילה העבודה על הפעולה.
end_time

Timestamp

השעה שבה הפעולה הסתיימה – בהצלחה או לא. יש לבטל את ההגדרה אם הפעולה עדיין פעילה.
operation_state

OperationState

המצב של פעולת הייבוא.
progress_documents

Progress

הערכה של מספר המסמכים שעובדו.
progress_bytes

Progress

הערכה של מספר הבייטים שעובדו.
collection_ids[]

string

אילו מזהי אוספים מיובאים.
input_uri_prefix

string

מיקום המסמכים המיובאים.

ImportDocumentsRequest

הבקשה על FirestoreAdmin.ImportDocuments.

שדות
name

string

מסד נתונים לייבוא. הוא אמור להופיע בפורמט: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

אילו מזהי אוספים לייבא המשמעות של 'לא צוין' היא כל האוספים הכלולים בייבוא.
input_uri_prefix

string

מיקום הקבצים שיוצאו. הערך הזה חייב להתאים לפלט_uri_prefix של ExportDocumentsResponse מייצוא שהושלם בהצלחה. למידע נוסף: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.

אינדקס

הגדרה של אינדקס.

שדות
name

string

שם המשאב של האינדקס. פלט בלבד.
collection_id

string

מזהה הקולקציה שעליה חל האינדקס הזה. חובה.
fields[]

IndexField

השדות שצריך להוסיף לאינדקס.
state

State

מצב האינדקס. פלט בלבד.

ארץ

המצב של אינדקס. במהלך יצירת האינדקס, האינדקס יהיה במצב CREATING. אם האינדקס נוצר בהצלחה, הוא יעבור למצב READY. אם לא ניתן ליצור את האינדקס, הוא יעבור למצב ERROR.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED לא צוינה המדינה.
CREATING האינדקס נוצר. יש פעולה פעילה לאורך זמן עבור האינדקס. האינדקס מתעדכן כשכותבים מסמך. ייתכן שיהיו נתוני אינדקס מסוימים.
READY האינדקס מוכן לשימוש. האינדקס מתעדכן כשכותבים מסמך. האינדקס מאוכלס במלואו מכל המסמכים המאוחסנים בו.
ERROR האינדקס נוצר, אבל משהו השתבש. אין פעולה פעילה לטווח ארוך עבור האינדקס, והפעולה הממושכת האחרונה שהסתיימה נכשלה. האינדקס לא מתעדכן כשכותבים מסמך. ייתכן שיהיו נתוני אינדקס מסוימים.

IndexField

שדה של אינדקס.

שדות
field_path

string

הנתיב של השדה. חייב להתאים למפרט נתיב השדות המתואר על ידי [google.firestore.v1beta1.Document.fields][fields]. אפשר להשתמש בנתיב השדה המיוחד __name__ לבדו, או בסוף נתיב. ניתן להשתמש ב-__type__ רק בסוף הנתיב.
mode

Mode

מצב השדה.

מצב

המצב קובע איך השדה יתווסף לאינדקס.

טיפוסים בני מנייה (enums)
MODE_UNSPECIFIED המצב לא צוין.
ASCENDING ערכי השדה נוספים לאינדקס כדי לתמוך בסדרת רצף בסדר עולה וגם לבצע שאילתה לפי <, >, <=, >= ו-=.
DESCENDING ערכי השדה נוספים לאינדקס כדי לתמוך בסדרת רצף בסדר יורד וגם לבצע שאילתה לפי <, >, <=, >= ו-=.
ARRAY_CONTAINS ערכי המערך של השדה נוספים לאינדקס כדי לתמוך בחברות באמצעות שאילתות ARRAY_CONTAINS.

IndexOperationMetadata

מטא-נתונים לפעולות אינדקס. מטא-נתונים אלה מאכלסים את שדה המטא-נתונים של google.longrunning.Operation.

שדות
start_time

Timestamp

השעה שבה התחילה העבודה על הפעולה.
end_time

Timestamp

השעה שבה הפעולה הסתיימה – בהצלחה או לא. יש לבטל את ההגדרה אם הפעולה עדיין פעילה.
index

string

משאב האינדקס שעליו פועלת הפעולה. לדוגמה: projects/{project_id}/databases/{database_id}/indexes/{index_id}
operation_type

OperationType

סוג פעולת האינדקס.
cancelled

bool

True אם google.longrunning.Operation בוטל. במהלך תהליך הביטול, הערך של הביטול יהיה True אבל הערך של google.longrunning.Operation.done יהיה False.
document_progress

Progress

התקדמות הפעולה הקיימת, נמדדת במספר המסמכים.

OperationType

סוג פעולת האינדקס.

טיפוסים בני מנייה (enums)
OPERATION_TYPE_UNSPECIFIED לא צוין. אף פעם לא הוגדר על ידי השרת.
CREATING_INDEX הפעולה יוצרת את האינדקס. הופעלה קריאת CreateIndex.

ListIndexesRequest

הבקשה על FirestoreAdmin.ListIndexes.

שדות
parent

string

שם מסד הנתונים. לדוגמה: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

הגודל הרגיל של דף רשימה.
page_token

string

האסימון הרגיל של דף הרשימה.

ListIndexesResponse

התשובה עבור FirestoreAdmin.ListIndexes.

שדות
indexes[]

Index

האינדקסים.
next_page_token

string

האסימון הסטנדרטי 'רשימה של הדף הבא'.

LocationMetadata

אין שדות בסוג הזה.

הודעת המטא-נתונים של google.cloud.location.Location.metadata.

OperationState

המצבים השונים האפשריים של פעולה מתמשכת.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED לא צוין.
INITIALIZING הבקשה בשלבי הכנה לעיבוד.
PROCESSING הבקשה בעיבוד בפועל.
CANCELLING הבקשה נמצאת בתהליך ביטול לאחר שהמשתמש שנקרא google.long running.Operations.CancelOperation בפעולה.
FINALIZING הבקשה טופלה ונמצאת בשלב הסופי.
SUCCESSFUL הבקשה הושלמה בהצלחה.
FAILED עיבוד הבקשה הסתיים, אבל הייתה שגיאה.
CANCELLED ביטול הבקשה הסתיים אחרי למשתמש שנקרא google.longlong.Operations.CancelOperation.

ההתקדמות

מודד את ההתקדמות של מדד מסוים.

שדות
work_completed

int64

הערכה של כמות העבודה שהושלמה. לתשומת ליבך, הערך הזה עשוי להיות גדול מ-work_estimated.
work_estimated

int64

הערכה של כמות העבודה שיש לבצע. אפס אם הערכת העבודה לא זמינה. עשוי להשתנות עם התקדמות העבודה.