این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Package google.firestore.admin.v1

فهرست مطالب

FirestoreAdmin (رابط)
Backup (پیام)
Backup.State (enum)
BackupSchedule (پیام)
CreateBackupScheduleRequest (پیام)
CreateDatabaseMetadata (پیام)
CreateDatabaseRequest (پیام)
CreateIndexRequest (پیام)
DailyRecurrence (پیام)
Database (پیام)
Database.AppEngineIntegrationMode (enum)
Database.CmekConfig (پیام)
Database.ConcurrencyMode (enum)
Database.DatabaseType (enum)
Database.DeleteProtectionState (enum)
Database.PointInTimeRecoveryEnablement (enum)
DeleteBackupRequest (پیام)
DeleteBackupScheduleRequest (پیام)
DeleteDatabaseMetadata (پیام)
DeleteDatabaseRequest (پیام)
DeleteIndexRequest (پیام)
ExportDocumentsMetadata (پیام)
ExportDocumentsRequest (پیام)
ExportDocumentsResponse (پیام)
Field (پیام)
Field.IndexConfig (پیام)
Field.TtlConfig (پیام)
Field.TtlConfig.State (enum)
FieldOperationMetadata (پیام)
FieldOperationMetadata.IndexConfigDelta (پیام)
FieldOperationMetadata.IndexConfigDelta.ChangeType (enum)
FieldOperationMetadata.TtlConfigDelta (پیام)
FieldOperationMetadata.TtlConfigDelta.ChangeType (enum)
GetBackupRequest (پیام)
GetBackupScheduleRequest (پیام)
GetDatabaseRequest (پیام)
GetFieldRequest (پیام)
GetIndexRequest (پیام)
ImportDocumentsMetadata (پیام)
ImportDocumentsRequest (پیام)
Index (پیام)
Index.ApiScope (enum)
Index.IndexField (پیام)
Index.IndexField.ArrayConfig (enum)
Index.IndexField.Order (enum)
Index.IndexField.VectorConfig (پیام)
Index.IndexField.VectorConfig.FlatIndex (پیام)
Index.QueryScope (enum)
Index.State (تعدادی)
IndexOperationMetadata (پیام)
ListBackupSchedulesRequest (پیام)
ListBackupSchedulesResponse (پیام)
ListBackupsRequest (پیام)
ListBackupsResponse (پیام)
ListDatabasesRequest (پیام)
ListDatabasesResponse (پیام)
ListFieldsRequest (پیام)
ListFieldsResponse (پیام)
ListIndexesRequest (پیام)
ListIndexesResponse (پیام)
LocationMetadata (پیام)
OperationState (تعدادی)
Progress (پیام)
RestoreDatabaseMetadata (پیام)
RestoreDatabaseRequest (پیام)
UpdateBackupScheduleRequest (پیام)
UpdateDatabaseMetadata (پیام)
UpdateDatabaseRequest (پیام)
UpdateFieldRequest (پیام)
WeeklyRecurrence (پیام)

Firestore Admin

Cloud Firestore Admin API.

این API چندین سرویس اداری برای Cloud Firestore ارائه می دهد.

پروژه، پایگاه داده، فضای نام، مجموعه، گروه مجموعه و سند همانطور که در Google Cloud Firestore API تعریف شده است استفاده می شود.

عملیات: یک عملیات نشان دهنده کاری است که در پس زمینه انجام می شود.

سرویس ایندکس فهرست‌های Cloud Firestore را مدیریت می‌کند.

ایجاد ایندکس به صورت ناهمزمان انجام می شود. یک منبع عملیات برای هر عملیات ناهمزمان ایجاد می شود. وضعیت عملیات (شامل هر گونه خطای مواجه شده) ممکن است از طریق منبع عملیات پرس و جو شود.

مجموعه عملیات رکوردی از اقدامات انجام شده برای پروژه مشخص شده (از جمله هر عملیات در حال انجام) را ارائه می دهد. عملیات به طور مستقیم ایجاد نمی شود، بلکه از طریق تماس با مجموعه ها یا منابع دیگر ایجاد می شود.

عملیاتی که انجام می شود ممکن است حذف شود تا دیگر به عنوان بخشی از مجموعه عملیات در لیست قرار نگیرد. عملیات پس از 30 روز زباله جمع آوری می شود. به طور پیش فرض، ListOperations فقط در حال انجام و عملیات ناموفق برمی گردد. برای لیست کردن عملیات تکمیل شده، یک درخواست ListOperations با فیلتر done: true .

عملیات توسط سرویس FirestoreAdmin ایجاد می شود، اما از طریق سرویس google.longrunning.Operations قابل دسترسی است.

CreateBackupSchedule

CreateBackupSchedule
`rpc CreateBackupSchedule( CreateBackupScheduleRequest ) returns ( BackupSchedule )` یک برنامه پشتیبان در پایگاه داده ایجاد می کند. حداکثر دو زمان‌بندی پشتیبان‌گیری را می‌توان بر روی یک پایگاه داده پیکربندی کرد، یکی برنامه پشتیبان‌گیری روزانه با نگهداری تا 7 روز و یک برنامه پشتیبان هفتگی با نگهداری تا 14 هفته. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc CreateBackupSchedule( CreateBackupScheduleRequest ) returns ( BackupSchedule )

یک برنامه پشتیبان در پایگاه داده ایجاد می کند. حداکثر دو زمان‌بندی پشتیبان‌گیری را می‌توان بر روی یک پایگاه داده پیکربندی کرد، یکی برنامه پشتیبان‌گیری روزانه با نگهداری تا 7 روز و یک برنامه پشتیبان هفتگی با نگهداری تا 14 هفته.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

ایجاد پایگاه داده

ایجاد پایگاه داده
`rpc CreateDatabase( CreateDatabaseRequest ) returns ( Operation )` یک پایگاه داده ایجاد کنید. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc CreateDatabase( CreateDatabaseRequest ) returns ( Operation )

یک پایگاه داده ایجاد کنید.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

CreateIndex

CreateIndex
`rpc CreateIndex( CreateIndexRequest ) returns ( Operation )` یک شاخص ترکیبی ایجاد می کند. این یک `google.longrunning.Operation` را برمی گرداند که ممکن است برای ردیابی وضعیت ایجاد استفاده شود. ابرداده برای عملیات از نوع `IndexOperationMetadata` خواهد بود. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

یک شاخص ترکیبی ایجاد می کند. این یک google.longrunning.Operation را برمی گرداند که ممکن است برای ردیابی وضعیت ایجاد استفاده شود. ابرداده برای عملیات از نوع IndexOperationMetadata خواهد بود.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

حذف پشتیبان

حذف پشتیبان
`rpc DeleteBackup( DeleteBackupRequest ) returns ( Empty )` یک نسخه پشتیبان را حذف می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc DeleteBackup( DeleteBackupRequest ) returns ( Empty )

یک نسخه پشتیبان را حذف می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

DeleteBackupSchedule

DeleteBackupSchedule
`rpc DeleteBackupSchedule( DeleteBackupScheduleRequest ) returns ( Empty )` یک برنامه پشتیبان را حذف می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc DeleteBackupSchedule( DeleteBackupScheduleRequest ) returns ( Empty )

یک برنامه پشتیبان را حذف می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

حذف پایگاه داده

حذف پایگاه داده
`rpc DeleteDatabase( DeleteDatabaseRequest ) returns ( Operation )` پایگاه داده را حذف می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc DeleteDatabase( DeleteDatabaseRequest ) returns ( Operation )

پایگاه داده را حذف می کند.

محدوده مجوز

به یکی از حوزه های 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 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 باقی بماند. برای جزئیات بیشتر در مورد رفتار صادرات و قالب خروجی، مراجعه کنید: https://cloud.google.com/firestore/docs/manage-data/export-import محدوده مجوز به یکی از حوزه های 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 باقی بماند.

برای جزئیات بیشتر در مورد رفتار صادرات و قالب خروجی، مراجعه کنید: https://cloud.google.com/firestore/docs/manage-data/export-import

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

بازگشت تا

بازگشت تا
`rpc GetBackup( GetBackupRequest ) returns ( Backup )` اطلاعاتی در مورد یک نسخه پشتیبان دریافت می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc GetBackup( GetBackupRequest ) returns ( Backup )

اطلاعاتی در مورد یک نسخه پشتیبان دریافت می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

GetBackup Schedule

GetBackup Schedule
`rpc GetBackupSchedule( GetBackupScheduleRequest ) returns ( BackupSchedule )` اطلاعاتی در مورد یک برنامه پشتیبان دریافت می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc GetBackupSchedule( GetBackupScheduleRequest ) returns ( BackupSchedule )

اطلاعاتی در مورد یک برنامه پشتیبان دریافت می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

GetDatabase

GetDatabase
`rpc GetDatabase( GetDatabaseRequest ) returns ( Database )` اطلاعاتی در مورد پایگاه داده دریافت می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc GetDatabase( GetDatabaseRequest ) returns ( Database )

اطلاعاتی در مورد پایگاه داده دریافت می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

GetField

GetField
`rpc GetField( GetFieldRequest ) returns ( Field )` فراداده و پیکربندی یک فیلد را دریافت می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc GetField( GetFieldRequest ) returns ( Field )

فراداده و پیکربندی یک فیلد را دریافت می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

GetIndex

GetIndex
`rpc GetIndex( GetIndexRequest ) returns ( Index )` یک شاخص ترکیبی می گیرد. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc GetIndex( GetIndexRequest ) returns ( Index )

یک شاخص ترکیبی می گیرد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

Import Documents

Import Documents
`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 ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

اسناد را به Google Cloud Firestore وارد می کند. اسناد موجود با همین نام رونویسی می شوند. واردات در پس‌زمینه اتفاق می‌افتد و می‌توان پیشرفت آن را از طریق منبع عملیاتی که ایجاد می‌شود، نظارت و مدیریت کرد. اگر عملیات ImportDocuments لغو شود، ممکن است زیر مجموعه ای از داده ها قبلاً به Cloud Firestore وارد شده باشد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

ListBackup Schedules

ListBackup Schedules
`rpc ListBackupSchedules( ListBackupSchedulesRequest ) returns ( ListBackupSchedulesResponse )` فهرست برنامه های پشتیبان گیری محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc ListBackupSchedules( ListBackupSchedulesRequest ) returns ( ListBackupSchedulesResponse )

فهرست برنامه های پشتیبان گیری

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

پشتیبان گیری از لیست

پشتیبان گیری از لیست
`rpc ListBackups( ListBackupsRequest ) returns ( ListBackupsResponse )` همه ی نسخه های پشتیبان را لیست می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc ListBackups( ListBackupsRequest ) returns ( ListBackupsResponse )

همه ی نسخه های پشتیبان را لیست می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

ListDatabases

ListDatabases
`rpc ListDatabases( ListDatabasesRequest ) returns ( ListDatabasesResponse )` لیست تمام پایگاه های داده در پروژه. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc ListDatabases( ListDatabasesRequest ) returns ( ListDatabasesResponse )

لیست تمام پایگاه های داده در پروژه.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

ListFields

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` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

فهرست ایندکس ها

فهرست ایندکس ها
`rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )` فهرست های ترکیبی را فهرست می کند. محدوده مجوز به یکی از حوزه های 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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

بازیابی پایگاه داده

بازیابی پایگاه داده
`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` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

UpdateBackup Schedule

UpdateBackup Schedule
`rpc UpdateBackupSchedule( UpdateBackupScheduleRequest ) returns ( BackupSchedule )` یک برنامه پشتیبان را به روز می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc UpdateBackupSchedule( UpdateBackupScheduleRequest ) returns ( BackupSchedule )

یک برنامه پشتیبان را به روز می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

به روز رسانی پایگاه داده

به روز رسانی پایگاه داده
`rpc UpdateDatabase( UpdateDatabaseRequest ) returns ( Operation )` پایگاه داده را به روز می کند. محدوده مجوز به یکی از حوزه های OAuth زیر نیاز دارد: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

rpc UpdateDatabase( UpdateDatabaseRequest ) returns ( Operation )

پایگاه داده را به روز می کند.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

UpdateField

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` برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.

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`	نسخه پشتیبان در حال حاضر در دسترس نیست.

Backup Schedule

یک برنامه پشتیبان برای پایگاه داده 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` ضروری. برنامه پشتیبان برای ایجاد.

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 کاراکتر باشد. کاراکترهای معتبر /[az][0-9]-/ هستند که کاراکتر اول یک حرف و آخرین کاراکتر یک حرف یا یک عدد است. نباید شبیه UUID باشد /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. شناسه پایگاه داده "(پیش فرض)" نیز معتبر است.

parent

string

ضروری. نام والد projects/{project_id}

database

Database

ضروری. پایگاه داده برای ایجاد.

database_id

string

ضروری. شناسه مورد استفاده برای پایگاه داده، که جزء نهایی نام منبع پایگاه داده خواهد شد.

این مقدار باید 4-63 کاراکتر باشد. کاراکترهای معتبر /[az][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` ضروری. شاخص ترکیبی برای ایجاد.

parent

string

ضروری. نام والد فرم projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

ضروری. شاخص ترکیبی برای ایجاد.

عود روزانه

این نوع هیچ فیلدی ندارد.

نشان دهنده یک برنامه تکراری است که هر روز در یک زمان خاص اجرا می شود.

منطقه زمانی 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 روز است. در غیر این صورت مدت نگهداری 1 ساعت است.
`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` فقط خروجی کلید_پیشوند برای این پایگاه داده. این کلید_پیشوند در ترکیب با شناسه پروژه (" ~ ") برای ساخت شناسه برنامه که از APIهای Cloud Datastore در زمان اجراهای نسل اول Google App Engine بازگردانده می شود. این مقدار ممکن است خالی باشد که در این صورت برنامه کاربردی برای استفاده از کلیدهای رمزگذاری شده با URL پروژه_id است (به عنوان مثال: foo به جای v~foo).
`delete_protection_state`	`DeleteProtectionState` وضعیت حفاظت از حذف برای پایگاه داده.
`etag`	`string` این چک‌سوم توسط سرور بر اساس مقدار فیلدهای دیگر محاسبه می‌شود و ممکن است در درخواست‌های به‌روزرسانی و حذف ارسال شود تا اطمینان حاصل شود که مشتری قبل از ادامه، مقدار به‌روزی دارد.

AppEngineIntegrationMode

نوع حالت یکپارچه سازی App Engine.

Enums

APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED استفاده نشده.

ENABLED اگر یک برنامه App Engine در همان منطقه این پایگاه داده وجود داشته باشد، پیکربندی App Engine بر این پایگاه داده تأثیر می گذارد. این شامل غیرفعال کردن برنامه و پایگاه داده و همچنین غیرفعال کردن نوشتن در پایگاه داده است.

Enums
`APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED`	استفاده نشده.
`ENABLED`	اگر یک برنامه App Engine در همان منطقه این پایگاه داده وجود داشته باشد، پیکربندی App Engine بر این پایگاه داده تأثیر می گذارد. این شامل غیرفعال کردن برنامه و پایگاه داده و همچنین غیرفعال کردن نوشتن در پایگاه داده است.
`DISABLED`	App Engine هیچ تاثیری بر توانایی این پایگاه داده برای ارائه درخواست ها ندارد. این تنظیمات پیش‌فرض برای پایگاه‌های داده ایجاد شده با Firestore API است.

DISABLED

App Engine هیچ تاثیری بر توانایی این پایگاه داده برای ارائه درخواست ها ندارد.

این تنظیمات پیش‌فرض برای پایگاه‌های داده ایجاد شده با Firestore API است.

حالت همزمانی

نوع حالت کنترل همزمان برای تراکنش ها.

Enums
`CONCURRENCY_MODE_UNSPECIFIED`	استفاده نشده.
`OPTIMISTIC`	به طور پیش فرض از کنترل همزمان خوش بینانه استفاده کنید. این حالت برای پایگاه داده های Cloud Firestore در دسترس است.
`PESSIMISTIC`	به طور پیش فرض از کنترل همزمان بدبینانه استفاده کنید. این حالت برای پایگاه داده های Cloud Firestore در دسترس است. این تنظیم پیش فرض برای Cloud Firestore است.
`OPTIMISTIC_WITH_ENTITY_GROUPS`	به طور پیش فرض از کنترل همزمانی خوش بینانه با گروه های موجود استفاده کنید. این تنها حالت موجود برای Cloud Datastore است. این حالت برای Cloud Firestore با حالت Datastore نیز موجود است اما توصیه نمی شود.

نوع پایگاه داده

نوع پایگاه داده برای اطلاعات در مورد نحوه انتخاب به 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

فعال کردن ویژگی Point In Time Recovery.

Enums

POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED استفاده نشده.

Enums
`POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED`	استفاده نشده.
`POINT_IN_TIME_RECOVERY_ENABLED`	خواندن در نسخه‌های انتخابی داده‌ها در ۷ روز گذشته پشتیبانی می‌شود: در مقابل هر مهر زمانی در یک ساعت گذشته خوانده می شود در مقابل عکس‌های فوری ۱ دقیقه‌ای بیش از ۱ ساعت و در عرض ۷ روز می‌خواند برای تعیین نسخه های پشتیبانی شده می توان `version_retention_period` و `earliest_version_time` استفاده کرد.
`POINT_IN_TIME_RECOVERY_DISABLED`	خواندن در هر نسخه از داده ها در 1 ساعت گذشته پشتیبانی می شود.

POINT_IN_TIME_RECOVERY_ENABLED

خواندن در نسخه‌های انتخابی داده‌ها در ۷ روز گذشته پشتیبانی می‌شود:

در مقابل هر مهر زمانی در یک ساعت گذشته خوانده می شود
در مقابل عکس‌های فوری ۱ دقیقه‌ای بیش از ۱ ساعت و در عرض ۷ روز می‌خواند

برای تعیین نسخه های پشتیبانی شده می توان version_retention_period و earliest_version_time استفاده کرد.

POINT_IN_TIME_RECOVERY_DISABLED خواندن در هر نسخه از داده ها در 1 ساعت گذشته پشتیبانی می شود.

DeleteBackupRequest

درخواست FirestoreAdmin.DeleteBackup .

زمینه های

زمینه های
`name`	`string` ضروری. نام نسخه پشتیبان برای حذف. قالب `projects/{project}/locations/{location}/backups/{backup}` است.

name

string

ضروری. نام نسخه پشتیبان برای حذف.

قالب projects/{project}/locations/{location}/backups/{backup} است.

DeleteBackupScheduleRequest

درخواست برای [FirestoreAdmin.DeleteBackupSchedules][].

زمینه های

زمینه های
`name`	`string` ضروری. نام برنامه پشتیبان. قالب‌بندی `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`

name

string

ضروری. نام برنامه پشتیبان.

قالب‌بندی projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

DeleteDatabaseMetadata

این نوع هیچ فیلدی ندارد.

ابرداده مربوط به عملیات حذف پایگاه داده.

DeleteDatabaseRequest

درخواست FirestoreAdmin.DeleteDatabase .

زمینه های

زمینه های
`name`	`string` ضروری. نام `projects/{project_id}/databases/{database_id}`
`etag`	`string` تگ فعلی پایگاه داده. اگر تگ ارائه شود و با تگ فعلی پایگاه داده مطابقت نداشته باشد، حذف مسدود می شود و خطای FAILED_PRECONDITION برگردانده می شود.

name

string

ضروری. نام projects/{project_id}/databases/{database_id}

etag

string

تگ فعلی پایگاه داده. اگر تگ ارائه شود و با تگ فعلی پایگاه داده مطابقت نداشته باشد، حذف مسدود می شود و خطای FAILED_PRECONDITION برگردانده می شود.

DeleteIndexRequest

درخواست FirestoreAdmin.DeleteIndex .

زمینه های

زمینه های
`name`	`string` ضروری. نامی از `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`

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 اختیاری است. هنگام انتخاب نام، حتماً دستورالعمل‌های نام‌گذاری Google Cloud Storage را در نظر بگیرید: https://cloud.google.com/storage/docs/name . اگر URI یک سطل (بدون مسیر فضای نام) باشد، یک پیشوند بر اساس زمان شروع ایجاد می شود.
`namespace_ids[]`	`string` یک لیست خالی همه فضاهای نام را نشان می دهد. این استفاده ارجح برای پایگاه داده هایی است که از فضای نام استفاده نمی کنند. یک عنصر رشته خالی نشان دهنده فضای نام پیش فرض است. اگر پایگاه داده دارای داده‌هایی در فضای نام غیر پیش‌فرض است، اما نمی‌خواهد آنها را شامل شود، باید از این مورد استفاده شود. هر فضای نام در این لیست باید منحصر به فرد باشد.
`snapshot_time`	`Timestamp` مهر زمانی که مربوط به نسخه پایگاه داده ای است که باید صادر شود. مهر زمان باید در گذشته باشد، به دقیقه گرد شده و از `earliestVersionTime` قدیمی تر نباشد. در صورت مشخص شدن، اسناد صادر شده نمایانگر یک نمای ثابت از پایگاه داده در زمان ارائه شده خواهد بود. در غیر این صورت، هیچ تضمینی در مورد یکنواختی اسناد صادراتی وجود ندارد.

ExportDocumentsResponse

در فیلد پاسخ google.longrunning.Operation بازگردانده شد.

زمینه های

زمینه های
`output_uri_prefix`	`string` محل قرارگیری فایل های خروجی این می تواند برای شروع وارد کردن به Cloud Firestore (این پروژه یا پروژه دیگر) پس از تکمیل موفقیت آمیز عملیات استفاده شود.

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 named` address.city `, not the map key` `in the field` `.` "" `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` هستند فعال یا غیرفعال می کند.

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 named address.city , not the map key in the field . "*" 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` فقط خروجی وقتی درست است، پیکربندی نمایه `Field` از پیکربندی مشخص شده توسط `ancestor_field` تنظیم می شود. هنگامی که نادرست است، پیکربندی نمایه `Field` به صراحت تعریف می شود.
`ancestor_field`	`string` فقط خروجی نام منبع `Field` را مشخص می‌کند که پیکربندی فهرست این فیلد از آن تنظیم شده است (زمانی که `uses_ancestor_config` درست است)، یا اگر این فیلد پیکربندی فهرستی نداشته باشد، از آن تنظیم می‌شود (زمانی که `uses_ancestor_config` نادرست است).
`reverting`	`bool` فقط خروجی وقتی درست است، پیکربندی نمایه `Field` در حال بازگردانی است. پس از تکمیل، پیکربندی ایندکس به همان حالت فیلد مشخص شده توسط `ancestor_field` منتقل می‌شود، در این مرحله `uses_ancestor_config` `true` و `reverting` `false` خواهد بود.

TtlConfig

پیکربندی TTL (زمان تا زندگی) برای اسنادی که دارای این مجموعه Field هستند.

ذخیره یک مقدار مهر زمانی در یک فیلد فعال با TTL به عنوان زمان انقضای مطلق سند تلقی می شود. مقادیر مهر زمانی در گذشته نشان می دهد که سند برای انقضای فوری واجد شرایط است. استفاده از هر نوع داده دیگری یا عدم وجود فیلد، انقضا را برای سند جداگانه غیرفعال می کند.

زمینه های

زمینه های
`state`	`State` فقط خروجی وضعیت پیکربندی TTL.

state

State

فقط خروجی وضعیت پیکربندی TTL.

حالت

وضعیت اعمال پیکربندی TTL برای همه اسناد.

Enums
`STATE_UNSPECIFIED`	وضعیت نامشخص یا ناشناخته است.
`CREATING`	TTL در حال اعمال است. یک عملیات طولانی مدت فعال برای ردیابی تغییر وجود دارد. اسناد جدید نوشته شده دارای TTLهای درخواستی خواهند بود. TTLهای درخواستی در اسناد موجود هنوز در حال پردازش هستند. هنگامی که TTLها در تمام اسناد موجود پردازش شدند، وضعیت به "ACTIVE" منتقل می شود.
`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

شاخص در حال تغییر است.

تغییر نوع

نحوه تغییر شاخص را مشخص می کند.

Enums
`CHANGE_TYPE_UNSPECIFIED`	نوع تغییر مشخص یا مشخص نیست.
`ADD`	فهرست تک فیلد در حال اضافه شدن است.
`REMOVE`	فهرست تک فیلد در حال حذف شدن است.

TtlConfigDelta

اطلاعات مربوط به تغییر پیکربندی TTL.

زمینه های

change_type

ChangeType

نحوه تغییر پیکربندی TTL را مشخص می کند.

تغییر نوع

نحوه تغییر پیکربندی 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` محل فایل های صادر شده این باید با output_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__` به صورت صعودی مرتب می شود (مگر اینکه به صراحت مشخص شده باشد). برای فهرست های تک فیلد، این همیشه دقیقاً یک ورودی با مسیر فیلد برابر با مسیر فیلد مربوطه خواهد بود.
`state`	`State` فقط خروجی وضعیت خدمات شاخص.

ApiScope

API Scope APIهایی (Firestore Native یا Firestore در حالت Datastore) را تعریف می کند که برای پرس و جوها پشتیبانی می شوند.

Enums
`ANY_API`	این فهرست را فقط می‌توان توسط Firestore Native query API استفاده کرد. این پیش فرض است.
`DATASTORE_MODE_API`	این فهرست فقط توسط Firestore در حالت Datastore Query API قابل استفاده است.

IndexField

یک فیلد در یک شاخص field_path توضیح می دهد که کدام فیلد ایندکس شده است، value_mode نحوه نمایه شدن مقدار فیلد را توضیح می دهد.

زمینه های
`field_path`	`string` می تواند نام باشد. برای فهرست های تک فیلد، این باید با نام فیلد مطابقت داشته باشد یا ممکن است حذف شود.
فیلد اتحادیه `value_mode` . چگونه مقدار فیلد ایندکس می شود. `value_mode` فقط می تواند یکی از موارد زیر باشد:
`order`	`Order` نشان می دهد که این فیلد از ترتیب با ترتیب مشخص شده یا مقایسه با استفاده از =، !=، <، <=، >، >= پشتیبانی می کند.
`array_config`	`ArrayConfig` نشان می دهد که این فیلد از عملیات روی `array_value` s پشتیبانی می کند.
`vector_config`	`VectorConfig` نشان می دهد که این فیلد از عملیات نزدیکترین همسایه و فاصله بر روی بردار پشتیبانی می کند.

ArrayConfig

تنظیمات ارزش آرایه پشتیبانی شده

Enums
`ARRAY_CONFIG_UNSPECIFIED`	این فهرست از پرس و جوهای آرایه اضافی پشتیبانی نمی کند.
`CONTAINS`	ایندکس از پرس و جوهای مربوط به آرایه پشتیبانی می کند.

سفارش

سفارشات پشتیبانی شده

Enums
`ORDER_UNSPECIFIED`	سفارش مشخص نیست گزینه معتبری نیست
`ASCENDING`	فیلد بر اساس مقدار فیلد صعودی مرتب می شود.
`DESCENDING`	فیلد بر اساس مقدار فیلد نزولی مرتب می شود.

VectorConfig

پیکربندی نمایه برای پشتیبانی از عملیات جستجوی برداری

زمینه های

dimension

int32

ضروری. بعد برداری که این پیکربندی برای آن اعمال می شود.

شاخص به دست آمده فقط شامل بردارهای این بعد است و می تواند برای جستجوی برداری با همان بعد استفاده شود.

type فیلد اتحادیه نوع شاخص مورد استفاده type می تواند تنها یکی از موارد زیر باشد:

flat

FlatIndex

نشان می دهد که شاخص برداری یک شاخص مسطح است.

FlatIndex

این نوع هیچ فیلدی ندارد.

شاخصی که بردارها را در یک ساختار داده مسطح ذخیره می کند و از جستجوی جامع پشتیبانی می کند.

QueryScope

Query Scope محدوده ای را که یک پرس و جو در آن اجرا می شود را تعریف می کند. این در یک فیلد StructuredQuery from مشخص شده است.

Enums
`QUERY_SCOPE_UNSPECIFIED`	محدوده پرس و جو مشخص نشده است. گزینه معتبری نیست
`COLLECTION`	نمایه‌هایی با محدوده جستجوی مجموعه مشخص شده، درخواست‌هایی را در برابر مجموعه‌ای که فرزند یک سند خاص است، مشخص شده در زمان پرس و جو، و دارای شناسه مجموعه مشخص شده توسط ایندکس است، اجازه می‌دهند.
`COLLECTION_GROUP`	نمایه‌هایی با محدوده پرس و جوی گروه مجموعه مشخص شده، درخواست‌هایی را در برابر همه مجموعه‌هایی که دارای شناسه مجموعه مشخص شده توسط ایندکس هستند، اجازه می‌دهند.
`COLLECTION_RECURSIVE`	تمام اجداد مجموعه ها را در فهرست قرار دهید. فقط برای پایگاه های داده Datastore Mode موجود است.

حالت

وضعیت یک شاخص در طول ایجاد ایندکس، یک نمایه در حالت CREATING خواهد بود. اگر نمایه با موفقیت ایجاد شود، به حالت READY منتقل می شود. اگر ایجاد ایندکس با مشکل مواجه شود، ایندکس به حالت NEEDS_REPAIR منتقل می‌شود.

Enums
`STATE_UNSPECIFIED`	ایالت نامشخص است.
`CREATING`	شاخص در حال ایجاد است. یک عملیات طولانی مدت فعال برای شاخص وجود دارد. نمایه هنگام نوشتن یک سند به روز می شود. برخی از داده های شاخص ممکن است وجود داشته باشد.
`READY`	شاخص آماده استفاده است. نمایه هنگام نوشتن یک سند به روز می شود. فهرست به طور کامل از تمام اسناد ذخیره شده ای که برای آنها اعمال می شود پر شده است.
`NEEDS_REPAIR`	شاخص در حال ایجاد بود، اما مشکلی پیش آمد. هیچ عملیاتی طولانی مدت فعال برای این شاخص وجود ندارد و اخیراً به پایان رسیده است که عملیات طولانی مدت انجام نشد. این فهرست هنگام نوشتن یک سند به روز نمی شود. برخی از داده های فهرست ممکن است وجود داشته باشد. از API Google.Longrunning.Operations استفاده کنید تا مشخص کنید که چرا عملیاتی که آخرین بار برای ایجاد این شاخص تلاش کرده است شکست خورد ، سپس دوباره شاخص را ایجاد کنید.

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} = '-' استفاده کنید. این اجازه می دهد تا از لیست پشتیبان از یک مکان واحد یا از همه مکان ها استفاده کنید.

پاسخ لیست

پاسخ برای FirestoreAdmin.ListBackups .

زمینه های

backups[]

Backup

لیست کلیه پشتیبان گیری برای این پروژه.

unreachable[]

string

لیست مکانهایی که پشتیبان گیری های موجود از آن قادر به برداشتن نیستند.

این پاسخ به جای عدم موفقیت در کل درخواست ها در صورت عدم دسترسی یک مکان واحد ، یک مجموعه نتیجه جزئی و لیستی از مکانهایی را که قادر به دستیابی به اینجا نیستند ، برمی گرداند. این درخواست را می توان در برابر یک مکان واحد دوباره امتحان کرد تا خطای مشخصی داشته باشد.

listDatabasesRequest

درخواست لیست پایگاه داده های Firestore در همه مکان ها برای یک پروژه.

زمینه های

parent

string

ضروری. نام والدین projects/{project_id}

پاسخ لیست

لیست بانکهای اطلاعاتی برای یک پروژه.

زمینه های

databases[]

Database

بانکهای اطلاعاتی در پروژه.

unreachable[]

string

در صورتی که داده های مربوط به بانکهای اطلاعاتی فردی را نمی توان ذکر کرد ، آنها در اینجا ضبط می شوند.

به عنوان مثال ممکن است: پروژه ها/some_project/مکان/some_location این اتفاق می افتد اگر منطقه ابری که پایگاه داده در آن ساکن است در حال حاضر در دسترس نیست. در این حالت ما نمی توانیم تمام جزئیات مربوط به پایگاه داده را واگذار کنیم. ممکن است با ارسال درخواست "دریافت" برای منبع یا درخواست "لیست" برای مکان خاص ، بتوانید یک پیام خطای دقیق تر (یا احتمالاً منبع را واکشی کنید) دریافت کنید.

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` بازگشت که ممکن است برای به دست آوردن صفحه بعدی نتایج استفاده شود.

لیست

پاسخ برای 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

نشانه ای که ممکن است برای درخواست صفحه دیگری از نتایج استفاده شود. اگر خالی باشد ، این آخرین صفحه است.

مکان metadata

این نوع فیلدهایی ندارد.

پیام ابرداده برای google.cloud.location.Location.metadata .

عملیات

وضعیت عملیات را توصیف می کند.

Enums
`OPERATION_STATE_UNSPECIFIED`	نامشخص
`INITIALIZING`	درخواست برای پردازش آماده می شود.
`PROCESSING`	درخواست به طور فعال پردازش می شود.
`CANCELLING`	درخواست در حال لغو شدن پس از کاربر به نام Google.Longrunning.Operations.CanceLoperation در این عملیات است.
`FINALIZING`	درخواست پردازش شده و در مرحله نهایی خود قرار دارد.
`SUCCESSFUL`	درخواست با موفقیت به پایان رسیده است.
`FAILED`	درخواست پردازش به پایان رسیده است ، اما با خطایی روبرو شده است.
`CANCELLED`	درخواست پس از آنکه کاربر به نام google.longrunning.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.restedatabase] [google.firestore.admin.v1.restoredatabase].

زمینه های
`parent`	`string` ضروری. پروژه برای بازگرداندن پایگاه داده در قالب `projects/{project_id}` .
`database_id`	`string` ضروری. شناسه مورد استفاده برای پایگاه داده ، که به مؤلفه نهایی نام منبع پایگاه داده تبدیل می شود. این شناسه پایگاه داده نباید با یک پایگاه داده موجود همراه باشد. این مقدار باید 4-63 کاراکتر باشد. شخصیت های معتبر / [AZ] [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}`