Package google.firestore.admin.v1beta1

فهرست مطالب

Firestore Admin

Cloud Firestore Admin API.

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

مفاهیم

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

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

خدمات

فهرست مطالب

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

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

فراداده

فراداده و اطلاعات آماری در مورد داده ها در Cloud Firestore ارائه می دهد. ممکن است داده های ارائه شده به عنوان بخشی از این API قدیمی باشد.

عمل

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

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

عملیاتی که انجام می شود ممکن است حذف شود تا دیگر به عنوان بخشی از مجموعه عملیات در لیست قرار نگیرد.

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

CreateIndex

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

شاخص مشخص شده را ایجاد می کند. وضعیت اولیه یک نمایه جدید ایجاد شده CREATING است. پس از تکمیل google.longrunning.Operation بازگشتی، وضعیت READY خواهد بود. اگر فهرست از قبل وجود داشته باشد، تماس وضعیت ALREADY_EXISTS را برمی‌گرداند.

در حین ایجاد، فرآیند ممکن است منجر به خطا شود، در این صورت ایندکس به حالت ERROR خواهد رفت. این فرآیند را می توان با اصلاح داده هایی که باعث خطا شده اند، حذف ایندکس با delete و سپس ایجاد مجدد ایندکس با create بازیابی کرد.

فهرست هایی با یک فیلد واحد ایجاد نمی شوند.

محدوده مجوز

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

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

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

حذف ایندکس

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

یک فهرست را حذف می کند.

محدوده مجوز

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

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

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

صادرات اسناد

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

یک کپی از همه یا زیر مجموعه ای از اسناد را از Google Cloud Firestore به سیستم ذخیره سازی دیگری مانند Google Cloud Storage صادر می کند. به‌روزرسانی‌های اخیر اسناد ممکن است در صادرات منعکس نشود. صادرات در پس‌زمینه اتفاق می‌افتد و می‌توان پیشرفت آن را از طریق منبع عملیاتی ایجاد شده کنترل و مدیریت کرد. خروجی یک صادرات فقط زمانی می تواند مورد استفاده قرار گیرد که عملیات مربوطه انجام شود. اگر عملیات صادرات قبل از تکمیل لغو شود، ممکن است داده‌های جزئی در Google Cloud Storage باقی بماند.

محدوده مجوز

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

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

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

GetIndex

rpc GetIndex( GetIndexRequest ) returns ( Index )

شاخص می گیرد.

محدوده مجوز

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

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

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

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 ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

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

محدوده مجوز

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

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

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

CreateIndexRequest

درخواست FirestoreAdmin.CreateIndex .

زمینه های
parent

string

نام پایگاه داده ای که این شاخص برای آن اعمال می شود. برای مثال: projects/{project_id}/databases/{database_id}

index

Index

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

DeleteIndexRequest

درخواست FirestoreAdmin.DeleteIndex .

زمینه های
name

string

نام شاخص برای مثال: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

فراداده برای عملیات ExportDocuments.

زمینه های
start_time

Timestamp

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

end_time

Timestamp

زمانی که عملیات به پایان رسید، چه با موفقیت و چه در غیر این صورت. اگر عملیات همچنان فعال است، تنظیم را لغو کنید.

operation_state

OperationState

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

progress_documents

Progress

تخمینی از تعداد اسناد پردازش شده

progress_bytes

Progress

تخمینی از تعداد بایت های پردازش شده

collection_ids[]

string

کدام شناسه های مجموعه در حال صادرات هستند.

output_uri_prefix

string

جایی که نهادها به آن صادر می شوند.

ExportDocumentsRequest

درخواست FirestoreAdmin.ExportDocuments .

زمینه های
name

string

پایگاه داده برای صادرات باید به این شکل باشد: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

کدام شناسه مجموعه را صادر کنیم. نامشخص یعنی همه مجموعه ها.

output_uri_prefix

string

URI خروجی در حال حاضر فقط از URIهای Google Cloud Storage به شکل: gs://BUCKET_NAME[/NAMESPACE_PATH] پشتیبانی می‌کند، که در آن BUCKET_NAME نام سطل Google Cloud Storage و NAMESPACE_PATH یک مسیر فضای نام فضای ذخیره‌سازی ابری Google اختیاری است. هنگام انتخاب نام، حتماً دستورالعمل‌های نام‌گذاری Google Cloud Storage را در نظر بگیرید: https://cloud.google.com/storage/docs/name . اگر URI یک سطل (بدون مسیر فضای نام) باشد، یک پیشوند بر اساس زمان شروع ایجاد می شود.

ExportDocumentsResponse

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

زمینه های
output_uri_prefix

string

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

GetIndexRequest

درخواست FirestoreAdmin.GetIndex .

زمینه های
name

string

نام شاخص. برای مثال: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

فراداده برای عملیات ImportDocuments.

زمینه های
start_time

Timestamp

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

end_time

Timestamp

زمانی که عملیات به پایان رسید، چه با موفقیت و چه در غیر این صورت. اگر عملیات همچنان فعال است، تنظیم را لغو کنید.

operation_state

OperationState

وضعیت عملیات واردات.

progress_documents

Progress

تخمینی از تعداد اسناد پردازش شده

progress_bytes

Progress

تخمینی از تعداد بایت های پردازش شده

collection_ids[]

string

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

input_uri_prefix

string

محل اسناد وارد شده

ImportDocumentsRequest

درخواست FirestoreAdmin.ImportDocuments .

زمینه های
name

string

پایگاه داده برای وارد کردن باید به این شکل باشد: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

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

input_uri_prefix

string

محل فایل های صادر شده این باید با output_uri_prefix یک ExportDocumentsResponse از صادراتی که با موفقیت انجام شده است مطابقت داشته باشد. ببینید: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix .

فهرست مطالب

یک تعریف شاخص

زمینه های
name

string

نام منبع شاخص فقط خروجی

collection_id

string

شناسه مجموعه ای که این شاخص برای آن اعمال می شود. ضروری.

fields[]

IndexField

فیلدهایی که باید نمایه شوند.

state

State

وضعیت شاخص. فقط خروجی

حالت

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

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

IndexField

یک فیلد از یک شاخص

زمینه های
field_path

string

مسیر میدان. باید با مشخصات مسیر میدانی که توسط [google.firestore.v1beta1.Document.fields][fields] توضیح داده شده مطابقت داشته باشد. مسیر فیلد ویژه __name__ ممکن است به تنهایی یا در انتهای یک مسیر استفاده شود. __type__ فقط در انتهای مسیر قابل استفاده است.

mode

Mode

حالت میدان.

حالت

حالت نحوه نمایه شدن یک فیلد را تعیین می کند.

Enums
MODE_UNSPECIFIED حالت نامشخص است.
ASCENDING مقادیر فیلد به گونه‌ای ایندکس می‌شوند که از ترتیب‌بندی به ترتیب صعودی پشتیبانی می‌کنند و همچنین با <، >، <=، >=، و = پرس و جو می‌شوند.
DESCENDING مقادیر فیلد به گونه‌ای ایندکس می‌شوند که از ترتیب‌دهی به ترتیب نزولی پشتیبانی می‌کنند و همچنین با <، >، <=، >=، و = پرس و جو می‌شوند.
ARRAY_CONTAINS مقادیر آرایه فیلد برای پشتیبانی از عضویت با استفاده از پرس و جوهای ARRAY_CONTAINS ایندکس می شوند.

IndexOperationMetadata

فراداده برای عملیات شاخص. این ابرداده فیلد فراداده google.longrunning.Operation را پر می کند.

زمینه های
start_time

Timestamp

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

end_time

Timestamp

زمانی که عملیات به پایان رسید، چه با موفقیت و چه در غیر این صورت. اگر عملیات همچنان فعال است، تنظیم را لغو کنید.

index

string

منبع شاخصی که این عملیات روی آن عمل می کند. برای مثال: projects/{project_id}/databases/{database_id}/indexes/{index_id}

operation_type

OperationType

نوع عملیات شاخص

cancelled

bool

درست است اگر google.longrunning.Operation لغو شده باشد. اگر لغو در حال انجام باشد، لغو درست است اما google.longrunning.Operation.done نادرست خواهد بود.

document_progress

Progress

پیشرفت عملیات موجود، بر حسب تعداد اسناد اندازه گیری می شود.

نوع عملیات

نوع عملیات شاخص

Enums
OPERATION_TYPE_UNSPECIFIED نامشخص هرگز توسط سرور تنظیم نمی شود.
CREATING_INDEX عملیات در حال ایجاد شاخص است. با تماس CreateIndex آغاز شد.

ListIndexesRequest

درخواست FirestoreAdmin.ListIndexes .

زمینه های
parent

string

نام پایگاه داده برای مثال: projects/{project_id}/databases/{database_id}

filter

string

page_size

int32

اندازه صفحه فهرست استاندارد.

page_token

string

نشانه صفحه فهرست استاندارد.

ListIndexesResponse

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

زمینه های
indexes[]

Index

شاخص ها

next_page_token

string

نشانه استاندارد صفحه بعدی لیست.

مکان متادیتا

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

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

حالت عملیاتی

حالات مختلف ممکن برای یک عملیات در حال انجام.

Enums
STATE_UNSPECIFIED نامشخص
INITIALIZING درخواست در حال آماده سازی برای پردازش است.
PROCESSING درخواست به طور فعال در حال پردازش است.
CANCELLING پس از اینکه کاربر google.longrunning.Operations.CancelOperation را در عملیات نامید، درخواست در حال لغو شدن است.
FINALIZING درخواست رسیدگی شده و در مرحله نهایی شدن است.
SUCCESSFUL درخواست با موفقیت انجام شد.
FAILED پردازش درخواست به پایان رسید، اما با خطا مواجه شد.
CANCELLED پس از اینکه کاربر google.longrunning.Operations.CancelOperation را نامید، درخواست لغو شد.

پیش رفتن

پیشرفت یک متریک خاص را اندازه گیری می کند.

زمینه های
work_completed

int64

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

work_estimated

int64

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