Package google.firestore.admin.v1beta1

אינדקס

FirestoreAdmin

ממשק ה-API של Cloud Firestore Admin.

ממשק 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

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

מחק אינדקס

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

מוחק אינדקס.

היקפי הרשאה

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

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

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

ייצא מסמכים

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

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

ייבוא ​​מסמכים

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

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

רשימה אינדקסים

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

מטא נתונים עבור פעולות ExportDocuments.

שדות
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

מיקום הקבצים המיוצאים. זה חייב להתאים לקידומת output_uri_ של ExportDocumentsResponse מיצוא שהסתיים בהצלחה. ראה: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix .

אינדקס

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

שדות
name

string

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

collection_id

string

מזהה האוסף עליו חל אינדקס זה. נדרש.

fields[]

IndexField

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

state

State

מצב המדד. פלט בלבד.

מדינה

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

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

IndexField

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

שדות
field_path

string

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

mode

Mode

מצב השדה.

מצב

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

תקצירים
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

נכון אם google.longrunning.Operation בוטלה. אם הביטול נמצא בתהליך, הביטול יהיה נכון אבל google.longrunning.Operation.done יהיה שקר.

document_progress

Progress

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

OperationType

סוג פעולת המדד.

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

ListIndexRequest

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

שדות
parent

string

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

filter

string

page_size

int32

גודל עמוד הרשימה הסטנדרטי.

page_token

string

אסימון עמוד הרשימה הסטנדרטי.

ListIndexResponse

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

שדות
indexes[]

Index

האינדקסים.

next_page_token

string

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

מיקום מטא נתונים

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

הודעת המטא נתונים עבור google.cloud.location.Location.metadata .

OperationState

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

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

התקדמות

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

שדות
work_completed

int64

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

work_estimated

int64

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