Package google.firestore.admin.v1

אינדקס

FirestoreAdmin

Cloud Firestore Admin API.

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

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

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

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

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

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

פעולה שבוצעה עשויה להימחק כדי שהיא לא תופיע יותר כחלק מאוסף הפעולות. הפעולות הן פינוי אשפה לאחר 30 ימים. כברירת מחדל, ListOperations תחזיר רק פעולות שהביצוע שלהן נכשל. כדי לרשום פעולה שהושלמה, יש ליצור בקשת ListOperations עם המסנן done: true.

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

CreateBackupSchedule

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

יצירת לוח זמנים לגיבוי במסד נתונים. במסד נתונים אפשר להגדיר לכל היותר שני לוחות זמנים לגיבוי: לוח זמנים יומי אחד לגיבוי עם שמירה של עד 7 ימים ולוח זמנים שבועי לגיבוי עם שמירה של עד 14 שבועות.

היקפי הרשאות

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

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

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

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

יצירת מסד נתונים.

היקפי הרשאות

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

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

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

rpc CreateIndex(CreateIndexRequest) returns (Operation)

יצירת אינדקס מורכב. פעולה זו מחזירה google.longrunning.Operation שניתן להשתמש בו כדי לעקוב אחר סטטוס היצירה. המטא-נתונים של הפעולה יהיו מסוג IndexOperationMetadata.

היקפי הרשאות

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

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

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

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

מוחק גיבוי.

היקפי הרשאות

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

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

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

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

מחיקת לוח זמנים לגיבוי.

היקפי הרשאות

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

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

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

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

מחיקת מסד נתונים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.

למידע נוסף על התנהגות הייצוא ועל פורמט הפלט: https://cloud.google.com/firestore/docs/manage-data/export-import

היקפי הרשאות

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

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

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

rpc GetBackup(GetBackupRequest) returns (Backup)

קבלת מידע על גיבוי.

היקפי הרשאות

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

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

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

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

קבלת מידע על לוח זמנים לגיבוי.

היקפי הרשאות

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

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

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

rpc GetDatabase(GetDatabaseRequest) returns (Database)

מקבלת מידע על מסד נתונים.

היקפי הרשאות

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

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

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

rpc GetField(GetFieldRequest) returns (Field)

מקבל את המטא-נתונים וההגדרות של שדה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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

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

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

הצגת רשימה של לוחות הזמנים לגיבוי.

היקפי הרשאות

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

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

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

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

רשימה של כל הגיבויים.

היקפי הרשאות

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

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

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

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

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

היקפי הרשאות

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

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

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

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

פירוט ההגדרות והמטא-נתונים של השדות למסד הנתונים הזה.

בשלב זה, FirestoreAdmin.ListFields תומך רק בשדות של כרטיסי מוצר שבוטלו באופן מפורש. כדי לבצע את השאילתה הזו, צריך להפעיל את המסנן FirestoreAdmin.ListFields ולהגדיר את המסנן indexConfig.usesAncestorConfig:false או ttlConfig:*.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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

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

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

יצירת מסד נתונים חדש על ידי שחזור מגיבוי קיים.

מסד הנתונים החדש חייב להיות באותו אזור ענן או מיקום במספר אזורים כמו הגיבוי הקיים. הפעולה הזו מתנהגת כמו [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] אלא שבמקום ליצור מסד נתונים ריק חדש, נוצר מסד נתונים חדש עם סוג מסד הנתונים, תצורת האינדקס ומסמכים מגיבוי קיים.

ניתן להשתמש בקוד long-running operation כדי לעקוב אחר התקדמות השחזור, כאשר סוג השדה metadata של הפעולה הוא RestoreDatabaseMetadata. אם השחזור הצליח, הסוג response הוא Database. לא ניתן לקרוא או לכתוב את מסד הנתונים החדש עד לסיום ה-LRO.

היקפי הרשאות

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

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

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

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

מתבצע עדכון של לוח הזמנים לגיבוי.

היקפי הרשאות

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

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

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

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

מעדכן מסד נתונים.

היקפי הרשאות

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

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

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

rpc UpdateField(UpdateFieldRequest) returns (Operation)

מעדכן הגדרות של שדה. בשלב הזה, העדכונים בשדות חלים רק על הגדרה של אינדקס של שדה אחד. עם זאת, שיחות אל FirestoreAdmin.UpdateField צריכות לספק אנונימיזציה של שדות כדי למנוע שינוי של הגדרות אישיות שהמתקשר לא מודע להן. אנונימיזציה של השדות צריכה להיות מוגדרת כ: { paths: "index_config" }.

הקריאה הזו מחזירה google.longrunning.Operation שעשוי לשמש למעקב אחר הסטטוס של עדכון השדה. המטא-נתונים של הפעולה יהיו מסוג FieldOperationMetadata.

כדי לקבוע את הגדרות ברירת המחדל של השדות עבור מסד הנתונים, יש להשתמש במשתנה Field המיוחד עם שם המשאב: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

היקפי הרשאות

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

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

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

גיבוי

גיבוי של מסד נתונים של Cloud Firestore.

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

שדות
name

string

פלט בלבד. השם הייחודי של המשאב לגיבוי.

הפורמט הוא projects/{project}/locations/{location}/backups/{backup}.
database

string

פלט בלבד. שם מסד הנתונים של Firestore שממנו מגיע הגיבוי.

הפורמט הוא projects/{project}/databases/{database}.
database_uid

string

פלט בלבד. מזהה UUID4 שנוצר על ידי המערכת למסד הנתונים של Firestore שממנו מגיע הגיבוי.
snapshot_time

Timestamp

פלט בלבד. הגיבוי מכיל כרגע עותק של מסד הנתונים שעקבי כלפי חוץ.
expire_time

Timestamp

פלט בלבד. חותמת הזמן שבה יפוג תוקף הגיבוי.
state

State

פלט בלבד. המצב הנוכחי של הגיבוי.

ארץ

ציון המצב הנוכחי של הגיבוי.

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

BackupSchedule

לוח זמנים לגיבוי למסד נתונים של Cloud Firestore.

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

שדות
name

string

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

הפריט הזה יוקצה באופן אוטומטי.

הפורמט הוא projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
create_time

Timestamp

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

לא ייווצרו גיבויים ללוח הזמנים הזה לפני המועד הזה.
update_time

Timestamp

פלט בלבד. חותמת הזמן שבה לוח הזמנים הזה עודכן לאחרונה. כשיוצרים לראשונה לוח זמנים לגיבוי, הוא זהה לזה של create_time.
retention

Duration

באיזה זמן יחסי בעתיד, ביחס למועד היצירה של הגיבוי, צריך למחוק את הגיבוי. למשל, שמירת הגיבויים למשך 7 ימים.
שדה איחוד recurrence. שדה אחד שמייצג מתי יבוצעו הגיבויים. recurrence יכול להיות רק אחד מהבאים:
daily_recurrence

DailyRecurrence

ללוח זמנים שפועל מדי יום.
weekly_recurrence

WeeklyRecurrence

ללוח זמנים שפועל כל שבוע ביום מסוים.

CreateBackupScheduleRequest

הבקשה על FirestoreAdmin.CreateBackupSchedule.

שדות
parent

string

חובה. מסד הנתונים הראשי.

פרמוט של projects/{project}/databases/{database}
backup_schedule

BackupSchedule

חובה. לוח הזמנים לגיבוי שצריך ליצור.

CreateDatabaseMetadata

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

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

CreateDatabaseRequest

הבקשה על FirestoreAdmin.CreateDatabase.

שדות
parent

string

חובה. שם הורה בטופס projects/{project_id}
database

Database

חובה. מסד הנתונים ליצירה.
database_id

string

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

הערך צריך להכיל 4-63 תווים. התווים החוקיים הם /[a-z][0-9]-/ כאשר התו הראשון הוא אות והתו האחרון הוא אות או מספר. לא חייב להיות דמוי-UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

גם מזהה מסד הנתונים '(ברירת מחדל)' חוקי.

CreateIndexRequest

הבקשה על FirestoreAdmin.CreateIndex.

שדות
parent

string

חובה. שם הורה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

חובה. האינדקס המרוכב ליצירה.

DailyRecurrence

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

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

אזור הזמן הוא UTC.

מסד נתונים

מסד נתונים של Cloud Firestore.

שדות
name

string

שם המשאב של מסד הנתונים. פורמט: projects/{project}/databases/{database}
uid

string

פלט בלבד. מזהה UUID4 שנוצר על ידי המערכת למסד הנתונים הזה.
create_time

Timestamp

פלט בלבד. חותמת הזמן שבה נוצר מסד הנתונים. מסדי נתונים שנוצרו לפני 2016 לא מאכלסים את create_time.
update_time

Timestamp

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

string

מיקום מסד הנתונים. רשימת המיקומים הזמינים מפורטים בכתובת https://cloud.google.com/firestore/docs/locations.
type

DatabaseType

סוג מסד הנתונים. איך בוחרים אפשרות כזו: https://cloud.google.com/datastore/docs/firestore-or-datastore.
concurrency_mode

ConcurrencyMode

מצב השליטה בו-זמנית לשימוש במסד הנתונים הזה.
version_retention_period

Duration

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

כל read או query יכולים לציין read_time בתוך חלון זה, ויקראו את מצב מסד הנתונים באותו זמן.

אם התכונה PITR מופעלת, תקופת השמירה היא 7 ימים. אחרת, תקופת השמירה היא שעה אחת.
earliest_version_time

Timestamp

פלט בלבד. חותמת הזמן המוקדמת ביותר שבה ניתן לקרוא גרסאות ישנות יותר של הנתונים ממסד הנתונים. פרטים נוספים מופיעים בקטע [version_retention_period] שלמעלה. השדה הזה מאוכלס בנתונים הבאים: now - version_retention_period.

הערך הזה מתעדכן באופן קבוע, והופך למיושן ברגע שמתקבלת שאילתה. אם אתם משתמשים בערך הזה כדי לשחזר נתונים, הקפידו להביא בחשבון את פרק הזמן מהרגע שבו השאילתה לגבי הערך ועד לרגע שבו התחלתם את תהליך השחזור.
point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

האם להפעיל את התכונה PITR במסד הנתונים הזה.
app_engine_integration_mode

AppEngineIntegrationMode

מצב השילוב של App Engine שבו יש להשתמש עבור מסד הנתונים הזה.
key_prefix

string

פלט בלבד. המפתח_prefix למסד הנתונים הזה. נעשה שימוש ב-key_prefix הזה, בשילוב עם מזהה הפרויקט ("~") כדי ליצור את מזהה האפליקציה שהוחזר מממשקי ה-API של Cloud Datastore בשעות הריצה של Google App Engine מדור ראשון.

הערך הזה יכול להיות ריק. במקרה כזה, ה-appid שיש להשתמש בו עבור מפתחות בקידוד כתובת URL הוא project_id (למשל: foo במקום v~foo).
delete_protection_state

DeleteProtectionState

מצב ההגנה מפני מחיקה של מסד הנתונים.
etag

string

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

AppEngineIntegrationMode

מצב השילוב של App Engine.

טיפוסים בני מנייה (enums)
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED לא בשימוש.
ENABLED אם אפליקציה של App Engine קיימת באותו אזור שבו נמצא מסד הנתונים הזה, ההגדרה של App Engine תשפיע על מסד הנתונים הזה. זה כולל השבתה של האפליקציה ומסד הנתונים, וכן השבתת הכתיבה במסד הנתונים.
DISABLED

ל-App Engine אין השפעה על היכולת של מסד הנתונים הזה למלא בקשות.

זוהי הגדרת ברירת המחדל למסדי נתונים שנוצרו באמצעות Firestore API.

ConcurrencyMode

הסוג של מצב בקרת בו-זמנית בטרנזקציות.

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

השתמש בבקרה פסימית של בו-זמניות כברירת מחדל. המצב הזה זמין למסדי נתונים של Cloud Firestore.

זוהי הגדרת ברירת המחדל של Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

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

זהו המצב היחיד שזמין ל-Cloud Datastore.

המצב הזה זמין גם ב-Cloud Firestore עם מצב Datastore, אבל לא מומלץ.

DatabaseType

סוג מסד הנתונים. איך בוחרים אפשרות כזו: https://cloud.google.com/datastore/docs/firestore-or-datastore.

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

טיפוסים בני מנייה (enums)
DATABASE_TYPE_UNSPECIFIED ערך ברירת המחדל. נעשה שימוש בערך הזה אם סוג מסד הנתונים מושמט.
FIRESTORE_NATIVE מצב מקורי של Firestore
DATASTORE_MODE Firestore במצב Datastore.

DeleteProtectionState

מצב ההגנה מפני מחיקה של מסד הנתונים.

טיפוסים בני מנייה (enums)
DELETE_PROTECTION_STATE_UNSPECIFIED ערך ברירת המחדל. לא צוין סוג הגנה מפני מחיקה
DELETE_PROTECTION_DISABLED ההגנה מפני מחיקה מושבתת
DELETE_PROTECTION_ENABLED ההגנה מפני מחיקה מופעלת

PointInTimeRecoveryEnablement

הפעלת התכונה 'שחזור נקודת זמן'.

טיפוסים בני מנייה (enums)
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED לא בשימוש.
POINT_IN_TIME_RECOVERY_ENABLED

יש תמיכה בקריאות בגרסאות נבחרות של הנתונים מ-7 הימים האחרונים:

  • קריאה לפי חותמת זמן מהשעה האחרונה
  • קריאה כנגד תמונות מצב של דקה אחת מעבר לשעה ותוך 7 ימים

כדי לקבוע מהן הגרסאות הנתמכות, אפשר להשתמש ב-version_retention_period וב-earliest_version_time.
POINT_IN_TIME_RECOVERY_DISABLED יש תמיכה בקריאות בכל גרסה של הנתונים מהשעה האחרונה.

DeleteBackupRequest

הבקשה על FirestoreAdmin.DeleteBackup.

שדות
name

string

חובה. שם הגיבוי שרוצים למחוק.

הפורמט הוא projects/{project}/locations/{location}/backups/{backup}.

DeleteBackupScheduleRequest

הבקשה אל [FirestoreAdmin.DeleteBackupSchedules][].

שדות
name

string

חובה. השם של לוח הזמנים לגיבוי.

פרמוט של projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

DeleteDatabaseMetadata

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

מטא-נתונים שקשורים לפעולת המחיקה של מסד הנתונים.

DeleteDatabaseRequest

הבקשה על FirestoreAdmin.DeleteDatabase.

שדות
name

string

חובה. שם הטופס projects/{project_id}/databases/{database_id}
etag

string

ה-etag הנוכחי של מסד הנתונים. אם יסופק etag שאינו תואם ל-etag הנוכחי של מסד הנתונים, המחיקה תיחסם ותוחזר השגיאה FAILED_PRE בעקבות שגיאה.

DeleteIndexRequest

הבקשה על FirestoreAdmin.DeleteIndex.

שדות
name

string

חובה. שם הטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.ExportDocuments.

שדות
start_time

Timestamp

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

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
operation_state

OperationState

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

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
progress_bytes

Progress

ההתקדמות בבייטים של הפעולה הזו.
collection_ids[]

string

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

string

היעד שאליו המסמכים מיוצאים.
namespace_ids[]

string

אילו מזהי מרחבי שמות מיוצאים.
snapshot_time

Timestamp

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

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 הוא קטגוריה (ללא נתיב מרחב שמות), תיווצר קידומת על סמך שעת ההתחלה.
namespace_ids[]

string

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

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

Timestamp

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

ExportDocumentsResponse

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

שדות
output_uri_prefix

string

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

שדה

מייצג שדה אחד במסד הנתונים.

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

שדות
name

string

חובה. שם שדה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

נתיב של שדה יכול להיות שם של שדה פשוט, למשל address או נתיב לשדות בתוך map_value , כמו address.city, או נתיב של שדה מיוחד. השדה המיוחד החוקי היחיד הוא *, שמייצג כל שדה.

אפשר לצטט נתיבי שדות באמצעות (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` וכן באמצעות תווי ASCII.

דוגמאות: (הערה: התגובות כאן נכתבות בתחביר של סימני קריאה, כך שיש שכבה נוספת של סימני הטעמה שמייצגים בלוק קוד) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, ולא אף שדה.

Field מיוחד מכיל את הגדרות ברירת המחדל להוספה לאינדקס עבור כל השדות. שם המשאב בשדה הזה הוא: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* האינדקסים שהוגדרו ב-Field הזה יוחלו על כל השדות שאין להם תצורה משלהם של Field של אינדקס.
index_config

IndexConfig

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

TtlConfig

הגדרות TTL בשביל Field הזה. הגדרה או ביטול של ההגדרה תפעיל או תשבית את TTL עבור מסמכים עם Field זה.

IndexConfig

תצורת האינדקס עבור השדה הזה.

שדות
indexes[]

Index

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

bool

פלט בלבד. כאשר הערך הוא True, הגדרת האינדקס של Field נקבעת לפי ההגדרות שמצוינות ב-ancestor_field. כשהערך הוא False, הגדרת האינדקס של Field מוגדרת באופן מפורש.
ancestor_field

string

פלט בלבד. המדיניות מציינת את שם המשאב של Field שממנו מוגדרת תצורת האינדקס של השדה הזה (כאשר uses_ancestor_config מוגדרת כ-True), או שממנו יש להגדיר את המשאב אם לא הייתה הגדרת אינדקס בשדה הזה (כאשר uses_ancestor_config מוגדרת כ-False).
reverting

bool

הפלט רק כאשר הערך הוא True, הגדרת האינדקס של Field נמצאת בתהליך החזרה לגרסה קודמת. בסיום, הגדרת האינדקס תעבור לאותו מצב כמו השדה שצוין על ידי ancestor_field. בשלב הזה uses_ancestor_config יהיה true ו-reverting יהיה false.

TtlConfig

תצורת ה-TTL (זמן חיים) עבור מסמכים שבהם Field מוגדר.

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

שדות
state

State

פלט בלבד. מצב התצורה של ה-TTL.

ארץ

מצב החלת תצורת ה-TTL על כל המסמכים.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED המדינה לא צוינה או לא ידועה.
CREATING המערכת מחילה את ה-TTL. יש פעולה פעילה ממושכת כדי לעקוב אחר השינוי. על מסמכים חדשים שנכתבו יוחלו ערכי TTL בהתאם לבקשה. ערכי ה-TTL המבוקשים על מסמכים קיימים עדיין נמצאים בעיבוד. לאחר עיבוד ה-TTL בכל המסמכים הקיימים, המצב יעבור למצב 'פעיל'.
ACTIVE ה-TTL פעיל עבור כל המסמכים.
NEEDS_REPAIR לא ניתן להפעיל את תצורת ה-TTL עבור כל המסמכים הקיימים. על מסמכים חדשים שנכתבו עדיין יחולו ה-TTL שלהם. ה-LRO הוחזר כאשר הניסיון האחרון להפעיל TTL עבור Field זה נכשל, וייתכן שיש לו פרטים נוספים.

FieldOperationMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.UpdateField.

שדות
start_time

Timestamp

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

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
field

string

משאב השדה שעליו הפעולה הזו פועלת. לדוגמה: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

רשימה של IndexConfigDelta, שמתארת את כוונת הפעולה הזו.
state

OperationState

מצב הפעולה.
progress_documents

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
progress_bytes

Progress

ההתקדמות בבייטים של הפעולה הזו.
ttl_config_delta

TtlConfigDelta

מתאר את השינויים בתצורת TTL.

IndexConfigDelta

מידע על שינוי בהגדרה של האינדקס.

שדות
change_type

ChangeType

מציין את השינויים באינדקס.
index

Index

האינדקס שמשתנה.

ChangeType

מציין את השינויים באינדקס.

טיפוסים בני מנייה (enums)
CHANGE_TYPE_UNSPECIFIED סוג השינוי לא מצוין או לא ידוע.
ADD המערכת מוסיפה את האינדקס של השדה היחיד.
REMOVE מתבצעת הסרה של האינדקס של השדה היחיד.

TtlConfigDelta

מידע על שינוי בהגדרה של TTL.

שדות
change_type

ChangeType

מציין את השינויים בהגדרות של TTL.

ChangeType

מציין את השינויים בהגדרות של TTL.

טיפוסים בני מנייה (enums)
CHANGE_TYPE_UNSPECIFIED סוג השינוי לא מצוין או לא ידוע.
ADD מתבצעת הוספה של הגדרות ה-TTL.
REMOVE מתבצעת הסרה של הגדרות ה-TTL.

GetBackupRequest

הבקשה על FirestoreAdmin.GetBackup.

שדות
name

string

חובה. שם הגיבוי שיש לאחזר.

הפורמט הוא projects/{project}/locations/{location}/backups/{backup}.

GetBackupScheduleRequest

הבקשה על FirestoreAdmin.GetBackupSchedule.

שדות
name

string

חובה. השם של לוח הזמנים לגיבוי.

פרמוט של projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

GetDatabaseRequest

הבקשה על FirestoreAdmin.GetDatabase.

שדות
name

string

חובה. שם הטופס projects/{project_id}/databases/{database_id}

GetFieldRequest

הבקשה על FirestoreAdmin.GetField.

שדות
name

string

חובה. שם הטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

הבקשה על FirestoreAdmin.GetIndex.

שדות
name

string

חובה. שם הטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.ImportDocuments.

שדות
start_time

Timestamp

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

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
operation_state

OperationState

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

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
progress_bytes

Progress

ההתקדמות בבייטים של הפעולה הזו.
collection_ids[]

string

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

string

מיקום המסמכים המיובאים.
namespace_ids[]

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.v1.ExportDocumentsResponse.output_uri_prefix.
namespace_ids[]

string

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

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

אינדקס

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

שדות
name

string

פלט בלבד. שם שהוגדר על ידי שרת לאינדקס הזה. אופן השם של אינדקסים מרוכבים יהיה: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} אם מדובר באינדקסים עם שדה יחיד, השדה הזה יהיה ריק.
query_scope

QueryScope

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

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

ApiScope

היקף ההרשאות של ממשק ה-API שנתמך על ידי האינדקס הזה.
fields[]

IndexField

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

כדי ליצור אינדקסים מורכבים, צריך בין 2 ל-100 שדות לפחות. הערך האחרון בשדה הוא תמיד לנתיב השדה __name__. אם בזמן היצירה, __name__ לא צוין כשדה האחרון, הוא יתווסף באופן אוטומטי עם אותו כיוון כמו זה של השדה האחרון שהוגדר. אם השדה הסופי באינדקס מורכב אינו כיווני, הערך של __name__ יאורגן לפי ASCENDING (אלא אם צוין במפורש).

באינדקסים של שדה יחיד, זו תמיד תהיה רשומה אחת בדיוק עם נתיב שדה ששווה לנתיב השדה של השדה המשויך.
state

State

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

ApiScope

היקף ה-API מגדיר את ממשקי ה-API (Firestore Native או Firestore במצב Datastore) שנתמכים לשאילתות.

טיפוסים בני מנייה (enums)
ANY_API ניתן להשתמש באינדקס רק ב-Firestore Native Query API. (זוהי ברירת המחדל)
DATASTORE_MODE_API ניתן להשתמש באינדקס רק ב-Firestore ב-Datastore Mode של ממשק API.

IndexField

שדה באינדקס. השדה field_path מתאר את השדה שנוצר לאינדקס, וה-value_mode מתאר את האופן שבו ערך השדה נוסף לאינדקס.

שדות
field_path

string

יכול להיות name. באינדקסים של שדה יחיד, השדה הזה חייב להתאים לשם השדה או שאפשר להשמיט אותו.
שדה איחוד value_mode. האופן שבו ערך השדה נוסף לאינדקס. value_mode יכול להיות רק אחד מהבאים:
order

Order

מציין שהשדה הזה תומך בסדר קריאה לפי הסדר שנקבע או בהשוואה באמצעות הסימנים =, !=, <, <=, >, >=.
array_config

ArrayConfig

השדה הזה תומך בפעולות על ערכי array_value.
vector_config

VectorConfig

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

ArrayConfig

ההגדרות הנתמכות של ערכי המערך.

טיפוסים בני מנייה (enums)
ARRAY_CONFIG_UNSPECIFIED האינדקס לא תומך בשאילתות מערך נוספות.
CONTAINS האינדקס תומך בשאילתות לבלימת מערכים.

הזמנה

הסידורים הנתמכים.

טיפוסים בני מנייה (enums)
ORDER_UNSPECIFIED ההזמנה לא צוינה. האפשרות לא חוקית.
ASCENDING השדה מסודר לפי ערך שדה עולה.
DESCENDING השדה מסודר לפי ערך שדה יורד.

VectorConfig

הגדרת האינדקס לתמיכה בפעולות של חיפוש וקטורי

שדות
dimension

int32

חובה. מאפיין הווקטור שעליו חלה ההגדרה הזו.

האינדקס שיתקבל יכלול רק וקטורים של המאפיין הזה, ואפשר להשתמש בו לחיפוש וקטורי עם אותו מאפיין.
שדה איחוד type. סוג האינדקס שבשימוש. type יכול להיות רק אחד מהבאים:
flat

FlatIndex

מציין שאינדקס הווקטור הוא אינדקס שטוח.

FlatIndex

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

אינדקס שמאחסן וקטורים במבנה נתונים שטוח ותומך בחיפוש מקיף.

QueryScope

היקף השאילתה מגדיר את ההיקף שבו השאילתה רצה. יש לציין זאת בשדה from של שאילתה מובנית.

טיפוסים בני מנייה (enums)
QUERY_SCOPE_UNSPECIFIED היקף השאילתה לא צוין. האפשרות לא חוקית.
COLLECTION אינדקסים עם היקף שאילתת אוסף שצוין מאפשרים שאילתות באוסף שהוא הצאצא של מסמך ספציפי, שצוין בזמן השאילתה ושמזהה האוסף שצוין על ידי האינדקס.
COLLECTION_GROUP אינדקסים עם היקף שאילתה של קבוצת אוספים מוגדר לאפשר שאילתות לגבי כל האוספים שיש להם את מזהה האוסף שצוין על ידי האינדקס.
COLLECTION_RECURSIVE כוללים באינדקס את כל ישויות האב של הקולקציות. זמין רק למסדי נתונים במצב Datastore.

ארץ

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

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

IndexOperationMetadata

מטא-נתונים של google.longrunning.Operation תוצאות מ-FirestoreAdmin.CreateIndex.

שדות
start_time

Timestamp

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

Timestamp

הזמן שבו הפעולה הזו הושלמה. אם הפעולה עדיין מתבצעת, המערכת לא מוגדרת.
index

string

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

OperationState

מצב הפעולה.
progress_documents

Progress

ההתקדמות, במסמכים, של הפעולה הזו.
progress_bytes

Progress

ההתקדמות בבייטים של הפעולה הזו.

ListBackupSchedulesRequest

הבקשה על FirestoreAdmin.ListBackupSchedules.

שדות
parent

string

חובה. מסד הנתונים הראשי.

הפורמט הוא projects/{project}/databases/{database}.

ListBackupSchedulesResponse

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

שדות
backup_schedules[]

BackupSchedule

רשימה של כל לוחות הזמנים לגיבוי.

ListBackupsRequest

הבקשה על FirestoreAdmin.ListBackups.

שדות
parent

string

חובה. המיקום שממנו רוצים ליצור את רשימת הגיבויים.

הפורמט הוא projects/{project}/locations/{location}. אפשר להשתמש ב-{location} = '-' כדי להציג רשימה של גיבויים מכל המיקומים בפרויקט הנתון. כך ניתן לפרט גיבויים ממיקום יחיד או מכל המיקומים.

ListBackupsResponse

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

שדות
backups[]

Backup

רשימה של כל הגיבויים לפרויקט.
unreachable[]

string

רשימת המיקומים שמהם לא ניתן היה לאחזר את הגיבויים הקיימים.

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

ListDatabasesRequest

בקשה לרישום מסדי הנתונים של Firestore בכל המיקומים של פרויקט.

שדות
parent

string

חובה. שם הורה בטופס projects/{project_id}

ListDatabasesResponse

רשימת מסדי הנתונים של פרויקט.

שדות
databases[]

Database

מסדי הנתונים בפרויקט.
unreachable[]

string

אם לא ניתן לרשום נתונים על מסדי נתונים מסוימים, הם יתועדו כאן.

דוגמה לרשומה יכולה להיות: projects/some_project/locations/some_location. מצב זה יכול לקרות אם אזור הענן שבו נמצא מסד הנתונים לא זמין כרגע. במקרה הזה לא נוכל לאחזר את כל הפרטים על מסד הנתונים. כדי לקבל הודעת שגיאה מפורטת יותר (או שאפשר גם לאחזר את המשאב), אפשר לשלוח בקשת 'Get' למשאב או בקשת 'List' לגבי המיקום הספציפי.

ListFieldsRequest

הבקשה על FirestoreAdmin.ListFields.

שדות
parent

string

חובה. שם הורה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

המסנן שיוחל על התוצאות ברשימה. בשלב זה, FirestoreAdmin.ListFields תומך רק בשדות של כרטיסי מוצר שבוטלו באופן מפורש. כדי ליצור את השאילתה הזו, יש להפעיל את FirestoreAdmin.ListFields עם מסנן שכולל את indexConfig.usesAncestorConfig:false .
page_size

int32

מספר התוצאות שיש להחזיר.
page_token

string

אסימון דף שהוחזר מקריאה קודמת אל FirestoreAdmin.ListFields, וניתן להשתמש בו כדי לקבל את דף התוצאות הבא.

ListFieldsResponse

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

שדות
fields[]

Field

השדות הנדרשים.
next_page_token

string

אסימון דף שיכול לשמש לבקשת דף נוסף של תוצאות. אם השדה יישאר ריק, זהו הדף האחרון.

ListIndexesRequest

הבקשה על FirestoreAdmin.ListIndexes.

שדות
parent

string

חובה. שם הורה בטופס projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

המסנן שיוחל על התוצאות ברשימה.
page_size

int32

מספר התוצאות שיש להחזיר.
page_token

string

אסימון דף שהוחזר מקריאה קודמת אל FirestoreAdmin.ListIndexes, וניתן להשתמש בו כדי לקבל את דף התוצאות הבא.

ListIndexesResponse

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

שדות
indexes[]

Index

האינדקסים המבוקשים.
next_page_token

string

אסימון דף שיכול לשמש לבקשת דף נוסף של תוצאות. אם השדה יישאר ריק, זהו הדף האחרון.

LocationMetadata

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

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

OperationState

מתאר את מצב הפעולה.

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

ההתקדמות

מתאר את התקדמות הפעולה. יחידת העבודה היא כללית ויש לפרש אותה בהתאם למקום שבו משתמשים ב-Progress.

שדות
estimated_work

int64

כמות העבודה המשוערת.
completed_work

int64

כמות העבודה שהושלמה.

RestoreDatabaseMetadata

מטא-נתונים עבור ה-long-running operation מהבקשה [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

שדות
start_time

Timestamp

השעה שבה השחזור התחיל.
end_time

Timestamp

שעת הסיום של השחזור, לא מוגדרת לשחזורים מתמשכים.
operation_state

OperationState

מצב הפעולה של השחזור.
database

string

שם מסד הנתונים שאליו מתבצע השחזור.
backup

string

השם של שחזור הגיבוי מ-.
progress_percentage

Progress

אחוז הזמן שנותר לביצוע השחזור הוא אחוז משוער של הזמן שנותר.

RestoreDatabaseRequest

הודעת הבקשה אל [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

שדות
parent

string

חובה. הפרויקט שבו רוצים לשחזר את מסד הנתונים. הפורמט הוא projects/{project_id}.
database_id

string

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

הערך צריך להכיל 4-63 תווים. התווים החוקיים הם /[a-z][0-9]-/ כאשר התו הראשון הוא אות והתו האחרון הוא אות או מספר. לא חייב להיות דמוי-UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

גם מזהה מסד הנתונים '(ברירת מחדל)' חוקי.

שדה איחוד source.

source יכול להיות רק אחד מהבאים:
backup

string

גיבוי שממנו אפשר לשחזר. חייב להיות מאותו פרויקט של ההורה.

הפורמט הוא: projects/{project_id}/locations/{location}/backups/{backup}

UpdateBackupScheduleRequest

הבקשה על FirestoreAdmin.UpdateBackupSchedule.

שדות
backup_schedule

BackupSchedule

חובה. לוח הזמנים לגיבוי שצריך לעדכן.
update_mask

FieldMask

רשימת השדות לעדכון.

UpdateDatabaseMetadata

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

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

UpdateDatabaseRequest

הבקשה על FirestoreAdmin.UpdateDatabase.

שדות
database

Database

חובה. מסד הנתונים לעדכון.
update_mask

FieldMask

רשימת השדות לעדכון.

UpdateFieldRequest

הבקשה על FirestoreAdmin.UpdateField.

שדות
field

Field

חובה. השדה שצריך לעדכן.
update_mask

FieldMask

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

WeeklyRecurrence

לוח זמנים קבוע שפועל ביום מסוים בשבוע.

אזור הזמן הוא UTC.

שדות
day

DayOfWeek

היום בשבוע ההפעלה.

DAY_OF_WEEK_UNSPECIFIED אסור.