Package google.firestore.admin.v1beta1

索引

FirestoreAdmin

Cloud Firestore Admin API。

這個 API 提供多項 Cloud Firestore 管理服務。

概念

專案、資料庫、命名空間、集合和文件都會按照 Google Cloud Firestore API 中的定義使用。

作業：作業代表在背景執行的作業。

Service

索引

索引服務會管理 Cloud Firestore 索引。

索引建立作業會以非同步方式執行。系統會為每個這類非同步作業建立作業資源。您可以透過 Operation 資源查詢作業狀態 (包括發生任何錯誤)。

Metadata

提供 Cloud Firestore 中的資料的相關中繼資料和統計資料。在這個 API 中提供的資料可能已過時。

作業

「作業」集合提供對指定專案 (包括任何進行中的作業) 的操作記錄。作業不會直接建立，而是會透過其他集合或資源上的呼叫。

尚未完成的作業可能會遭到取消。取消要求並非同步進行，因此在要求取消之後，作業可能繼續執行一段時間。

已完成的作業可能會遭到刪除，進而不再列於作業集合中。

作業是由服務 FirestoreAdmin 建立，但可透過服務 google.longrunning.Operations 存取。

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

建立指定的索引。新建立的索引的初始狀態為 CREATING。傳回的 google.longrunning.Operation 完成後，狀態將為 READY。如果索引已存在，呼叫會傳回 ALREADY_EXISTS 狀態。

在建立期間，程序可能會發生錯誤，在此情況下，索引將移至 ERROR 狀態。如要復原這項程序，請修正造成錯誤的資料、使用 delete 移除索引，然後使用 create 重新建立索引。

無法建立含有一個欄位的索引。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

刪除索引。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

這個外掛程式能將 Google Cloud Firestore 中所有或部分文件的副本匯出至其他儲存系統，例如 Google Cloud Storage。近期對文件所做的更新可能不會反映在匯出檔案中。匯出作業會在背景中執行，您可以透過已建立的 Operation 資源來監控及管理進度。只有在相關作業完成後，才能使用匯出結果。如在匯出作業完成前取消，部分資料可能仍會留在 Google Cloud Storage 中。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

取得索引。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

這個外掛程式能將文件匯入 Google Cloud Firestore。名稱相同的現有文件會遭到覆寫。匯入作業會在背景中執行，您可以透過已建立的 Operation 資源來監控及管理進度。如果已取消 ImportDocuments 作業，可能是部分資料已匯入 Cloud Firestore。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

列出符合指定篩選條件的索引。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱驗證總覽。

CreateIndexRequest

FirestoreAdmin.CreateIndex 的要求。

欄位
parent

string

要套用這個索引的資料庫名稱。例如：projects/{project_id}/databases/{database_id}
index

Index

要建立的索引。名稱和狀態欄位僅供輸出，系統會予以忽略。無法建立或刪除某些單一欄位索引。

DeleteIndexRequest

FirestoreAdmin.DeleteIndex 的要求。

欄位
name

string

索引名稱。例如：projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

ExportDocuments 作業的中繼資料。

欄位
start_time

Timestamp

作業開始在作業上的時間。
end_time

Timestamp

作業結束的時間 (不論是成功還是其他原因)。如果作業仍在進行中，則為取消設定。
operation_state

OperationState

匯出作業的狀態。
progress_documents

Progress

預估已處理的文件數量。
progress_bytes

Progress

預估處理的位元組數。
collection_ids[]

string

要匯出的集合 ID。
output_uri_prefix

string

實體匯出目標位置。

ExportDocumentsRequest

FirestoreAdmin.ExportDocuments 的要求。

欄位
name

string

要匯出的資料庫。格式應為 projects/{project_id}/databases/{database_id}。
collection_ids[]

string

要匯出的集合 ID。「未指定」：表示所有集合。
output_uri_prefix

string

輸出 URI。目前僅支援以下格式的 Google Cloud Storage URI：gs://BUCKET_NAME[/NAMESPACE_PATH]，其中 BUCKET_NAME 是 Google Cloud Storage 值區的名稱，NAMESPACE_PATH 是選用的 Google Cloud Storage 命名空間路徑。選擇名稱時，請務必考量 Google Cloud Storage 的命名規範：https://cloud.google.com/storage/docs/naming。如果 URI 是值區 (沒有命名空間路徑)，系統會根據開始時間產生前置字串。

ExportDocumentsResponse

系統會透過 google.longrunning.Operation 回應欄位傳回。

欄位
output_uri_prefix

string

輸出檔案的位置。您可使用這組憑證，在作業成功完成後開始匯入 Cloud Firestore (這項專案或其他專案)。

GetIndexRequest

FirestoreAdmin.GetIndex 的要求。

欄位
name

string

索引的名稱。例如：projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

ImportDocuments 作業的中繼資料。

欄位
start_time

Timestamp

作業開始在作業上的時間。
end_time

Timestamp

作業結束的時間 (不論是成功還是其他原因)。如果作業仍在進行中，則為取消設定。
operation_state

OperationState

匯入作業的狀態。
progress_documents

Progress

預估已處理的文件數量。
progress_bytes

Progress

預估處理的位元組數。
collection_ids[]

string

要匯入的集合 ID。
input_uri_prefix

string

匯入文件的位置。

ImportDocumentsRequest

FirestoreAdmin.ImportDocuments 的要求。

欄位
name

string

要匯入的資料庫。格式應為 projects/{project_id}/databases/{database_id}。
collection_ids[]

string

要匯入的集合 ID。「未指定」表示匯入作業中的所有集合。
input_uri_prefix

string

匯出檔案的位置。這個值必須與已成功匯出的 ExportDocumentsResponse 的 output_uri_prefix。請參閱：google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix。

索引

索引定義。

欄位
name

string

索引的資源名稱。僅供輸出。
collection_id

string

要套用此索引的集合 ID。這是必填欄位。
fields[]

IndexField

要建立索引的欄位。
state

State

索引狀態。僅供輸出。

狀態

索引的狀態。建立索引時，索引會處於 CREATING 狀態。如果索引建立成功，則會轉換為 READY 狀態。如果無法建立索引，則會轉換為 ERROR 狀態。

列舉
STATE_UNSPECIFIED 未指定狀態。
CREATING 正在建立索引，索引有一個正在執行的長時間執行的作業。系統會在寫入文件時更新索引。部分索引資料可能存在。
READY 索引已可供使用。系統會在寫入文件時更新索引。索引會從所有套用索引的已儲存文件中完整填入。
ERROR 已建立索引，但發生錯誤。索引沒有正在執行的長時間執行作業，且最近結束的長時間執行作業失敗。寫入文件時，索引不會更新。部分索引資料可能存在。

IndexField

索引的欄位。

欄位
field_path

string

欄位路徑。必須符合 [google.firestore.v1beta1.Document.fields][fields] 描述的欄位路徑規格。特殊欄位路徑 __name__ 可單獨使用，也可以在路徑結尾使用。__type__ 只能在路徑結尾使用。
mode

Mode

欄位的模式。

方式

模式會決定欄位編入索引的方式。

列舉
MODE_UNSPECIFIED 未指定模式。
ASCENDING 系統會為欄位值建立索引，因此支援以遞增順序排列，也能依 <、>、<=、>= 和 = 進行查詢。
DESCENDING 系統會為欄位值建立索引，因此支援以遞減順序排列，以及依 <、>、<=、>= 和 = 查詢。
ARRAY_CONTAINS 系統會將欄位的陣列值編入索引，以便在使用 ARRAY_CONTAINS 查詢時支援成員資格。

IndexOperationMetadata

索引作業的中繼資料。這項中繼資料會填入 google.longrunning.Operation 的中繼資料欄位。

欄位
start_time

Timestamp

作業開始在作業上的時間。
end_time

Timestamp

作業結束的時間 (不論是成功還是其他原因)。如果作業仍在進行中，則為取消設定。
index

string

這項作業執行的索引資源。例如：projects/{project_id}/databases/{database_id}/indexes/{index_id}
operation_type

OperationType

索引作業的類型。
cancelled

bool

如果 google.longrunning.Operation 已取消，則為 True。如果取消作業正在進行中，取消作業會成立，但 google.longrunning.Operation.done 會顯示為 false。
document_progress

Progress

現有作業的進度，以文件數量測量。

OperationType

索引作業的類型。

列舉
OPERATION_TYPE_UNSPECIFIED 未指定。伺服器永不設定。
CREATING_INDEX 這項作業正在建立索引。透過 CreateIndex 呼叫啟動。

ListIndexesRequest

FirestoreAdmin.ListIndexes 的要求。

欄位
parent

string

資料庫名稱。例如：projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

標準清單頁面大小。
page_token

string

標準「清單」頁面符記。

ListIndexesResponse

FirestoreAdmin.ListIndexes 的回應。

欄位
indexes[]

Index

索引。
next_page_token

string

標準清單下一頁符記。

LocationMetadata

這個類型沒有任何欄位。

google.cloud.location.Location.metadata 的中繼資料訊息。

OperationState

進行中作業的各種可能狀態。

列舉
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

預估需要執行的工作量。如果無法取得工作預估值，則為 0。可能會隨著工作進度而改變。