このページは Cloud Translation API によって翻訳されました。

Package google.firestore.admin.v1beta1

索引

FirestoreAdmin（インターフェース）
CreateIndexRequest（メッセージ）
DeleteIndexRequest（メッセージ）
ExportDocumentsMetadata（メッセージ）
ExportDocumentsRequest（メッセージ）
ExportDocumentsResponse（メッセージ）
GetIndexRequest（メッセージ）
ImportDocumentsMetadata（メッセージ）
ImportDocumentsRequest（メッセージ）
Index（メッセージ）
Index.State（列挙型）
IndexField（メッセージ）
IndexField.Mode（列挙型）
IndexOperationMetadata（メッセージ）
IndexOperationMetadata.OperationType（列挙型）
ListIndexesRequest（メッセージ）
ListIndexesResponse（メッセージ）
LocationMetadata（メッセージ）
OperationState（列挙型）
Progress（メッセージ）

FirestoreAdmin

Cloud Firestore Admin API。

この API は、Cloud Firestore 用にいくつかの管理サービスを提供します。

概念

Project、Database、Namespace、Collection、Document は、Google Cloud Firestore API の定義に従って使用されます。

オペレーション: オペレーションは、バックグラウンドで実行される処理を表します。

サービス

索引

インデックスサービスは、Cloud Firestore のインデックスを管理します。

インデックスの作成は非同期的に行われます。オペレーションリソースは、このような非同期オペレーションごとに作成されます。オペレーションの状態（発生したエラーを含む）は、Operation リソースを使用してクエリできます。

メタデータ

Cloud Firestore 内のデータに関するメタデータと統計情報を提供します。この API の一部として提供されるデータは最新ではない可能性があります。

オペレーション

Operations コレクションは、指定したプロジェクトに対して実行されたアクション（進行中のオペレーションを含む）の記録を提供します。オペレーションは直接作成されるのではなく、他のコレクションまたはリソースの呼び出しを通じて作成されます。

まだ完了していないオペレーションはキャンセルされる可能性があります。キャンセルリクエストは非同期で、オペレーションはキャンセルのリクエストが行われた後もしばらく実行され続ける場合があります。

完了したオペレーションは削除され、オペレーションコレクションの一部として表示されなくなります。

オペレーションはサービス FirestoreAdmin によって作成されますが、サービス google.longrunning.Operations を介してアクセスされます。

CreateIndex

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

DeleteIndex
`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

詳細については、認証の概要をご覧ください。

ExportDocuments

ExportDocuments
`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` 詳細については、認証の概要をご覧ください。

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

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

詳細については、認証の概要をご覧ください。

ImportDocuments

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` 詳細については、認証の概要をご覧ください。

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

詳細については、認証の概要をご覧ください。

ListIndexes

ListIndexes
`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

詳細については、認証の概要をご覧ください。

CreateIndexRequest

FirestoreAdmin.CreateIndex のリクエスト。

フィールド

フィールド
`parent`	`string` このインデックスが適用されるデータベースの名前。例: `projects/{project_id}/databases/{database_id}`
`index`	`Index` 作成するインデックス。name フィールドと state フィールドは出力専用で、無視されます。特定の単一フィールドインデックスは作成も削除もできません。

parent

string

このインデックスが適用されるデータベースの名前。例: projects/{project_id}/databases/{database_id}

index

Index

作成するインデックス。name フィールドと state フィールドは出力専用で、無視されます。特定の単一フィールドインデックスは作成も削除もできません。

DeleteIndexRequest

FirestoreAdmin.DeleteIndex のリクエスト。

フィールド

フィールド
`name`	`string` インデックス名。例: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

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。現時点では、`gs://BUCKET_NAME[/NAMESPACE_PATH]` という形式の Google Cloud Storage URI のみがサポートされています。ここで、`BUCKET_NAME` は Google Cloud Storage バケットの名前、`NAMESPACE_PATH` はオプションの Google Cloud Storage 名前空間パスです。名前を決める際は、Google Cloud Storage の命名ガイドライン（https://cloud.google.com/storage/docs/naming）を必ず考慮してください。URI がバケット（名前空間パスなし）の場合、開始時間に基づいて接頭辞が生成されます。

name

string

エクスポートするデータベース。形式は projects/{project_id}/databases/{database_id} です。

collection_ids[]

string

エクスポートするコレクション ID。指定しない場合は、すべてのコレクションになります。

output_uri_prefix

string

出力 URI。現時点では、gs://BUCKET_NAME[/NAMESPACE_PATH] という形式の Google Cloud Storage URI のみがサポートされています。ここで、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（このプロジェクトまたは別のプロジェクト）へのインポートを開始できます。

output_uri_prefix

string

出力ファイルの場所。これにより、オペレーションが正常に完了した後に Cloud Firestore（このプロジェクトまたは別のプロジェクト）へのインポートを開始できます。

GetIndexRequest

FirestoreAdmin.GetIndex のリクエスト。

フィールド

フィールド
`name`	`string` インデックスの名前。例: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

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

インポート先のデータベース。形式は 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` フィールドのモード。

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。キャンセルが進行中の場合、cancels は 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` 標準的なリストの次ページのトークン。

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 を呼び出した後、リクエストのキャンセルが終了しました。

Progress

特定の指標の進捗状況を測定します。

フィールド

フィールド
`work_completed`	`int64` 完了した作業量の見積もり。これは `work_estimated` より大きい場合があります。
`work_estimated`	`int64` 実行する必要のある作業量の見積もり。作業量の見積もりを取得できない場合は 0。作業の進行に伴って変更される可能性があります。

work_completed

int64

完了した作業量の見積もり。これは work_estimated より大きい場合があります。

work_estimated

int64

実行する必要のある作業量の見積もり。作業量の見積もりを取得できない場合は 0。作業の進行に伴って変更される可能性があります。