Package google.firestore.admin.v1beta2

索引

FirestoreAdmin

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

複合インデックスを作成します。これにより google.longrunning.Operation が返されます。これを使用して、作成のステータスを追跡できます。オペレーションのメタデータは IndexOperationMetadata タイプになります。

承認スコープ

次の 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 に部分的なデータが残る可能性があります。

承認スコープ

次の OAuth スコープのいずれかが必要です。

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

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

rpc GetField(GetFieldRequest) returns (Field)

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

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

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

このデータベースのフィールド構成とメタデータを一覧表示します。

現在、FirestoreAdmin.ListFields は明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、フィルタを indexConfig.usesAncestorConfig:false に設定して FirestoreAdmin.ListFields を呼び出します。

承認スコープ

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

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

rpc UpdateField(UpdateFieldRequest) returns (Operation)

フィールド構成を更新します。現在、フィールドの更新は単一フィールド インデックス構成にのみ適用されます。ただし、呼び出し元が認識していない構成の変更を避けるため、FirestoreAdmin.UpdateField の呼び出しではフィールド マスクを指定する必要があります。フィールド マスクは { paths: "index_config" } として指定する必要があります。

この呼び出しは google.longrunning.Operation を返します。これを使用して、フィールド更新のステータスを追跡できます。オペレーションのメタデータは FieldOperationMetadata タイプになります。

データベースのデフォルトのフィールド設定を構成するには、リソース名 projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* を持つ特別な Field を使用します。

承認スコープ

次の 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}/collectionGroups/{collection_id} 形式の親の名前
index

Index

作成する複合インデックス。

DeleteIndexRequest

FirestoreAdmin.DeleteIndex のリクエスト。

フィールド
name

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} の形式の名前

ExportDocumentsMetadata

FirestoreAdmin.ExportDocuments からの結果 google.longrunning.Operation のメタデータ。

フィールド
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 がバケット（名前空間パスなし）の場合、開始時間に基づいて接頭辞が生成されます。

ExportDocumentsResponse

google.longrunning.Operation レスポンス フィールドで返されます。

フィールド
output_uri_prefix

string

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

項目

データベース内の単一のフィールドを表します。

フィールドは「コレクション グループ」でグループ化されます。コレクション グループとは、データベース内の同じ ID を持つすべてのコレクションを表します。

フィールド
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 で定義された構成に戻ります。このフィールドのすべてのインデックスを明示的に削除するには、インデックスの空のリストを含むインデックス構成を指定します。

IndexConfig

このフィールドのインデックス構成。

フィールド
indexes[]

Index

このフィールドでサポートされているインデックス。
uses_ancestor_config

bool

出力のみ。true の場合、Field のインデックス構成は ancestor_field で指定された構成から設定されます。false の場合、Field のインデックス構成は明示的に定義されます。
ancestor_field

string

出力のみ。このフィールドのインデックス構成の設定元（uses_ancestor_config が true の場合）またはこのフィールドのインデックス構成がない場合（uses_ancestor_config が false の場合）は設定される Field のリソース名を指定します。
reverting

bool

出力のみ。true の場合、Field のインデックス構成は復元中です。完了すると、インデックス構成は ancestor_field で指定されたフィールドと同じ状態に遷移し、その時点で uses_ancestor_config は true、reverting は false になります。

FieldOperationMetadata

FirestoreAdmin.UpdateField からの結果 google.longrunning.Operation のメタデータ。

フィールド
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

オペレーションの状態。
document_progress

Progress

このオペレーションの進行状況（ドキュメント単位）。
bytes_progress

Progress

このオペレーションの進行状況（バイト単位）。

IndexConfigDelta

インデックス構成の変更に関する情報。

フィールド
change_type

ChangeType

インデックスの変更方法を指定します。
index

Index

変更されるインデックス。

ChangeType

インデックスの変更方法を指定します。

列挙型
CHANGE_TYPE_UNSPECIFIED 変更の種類は特定されていないか、不明です。
ADD 単一フィールド インデックスが追加されます。
REMOVE 単一フィールド インデックスは削除されます。

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

FirestoreAdmin.ImportDocuments からの結果 google.longrunning.Operation のメタデータ。

フィールド
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.v1beta2.ExportDocumentsResponse.output_uri_prefix をご覧ください。

索引

Cloud Firestore のインデックスを使用すると、データベース内のドキュメントに対して単純なクエリから複雑なクエリを行うことができます。

フィールド
name

string

出力のみ。このインデックスに対してサーバーで定義された名前。複合インデックスの名前の形式は、projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} のようになります。単一フィールド インデックスの場合、このフィールドは空になります。
query_scope

QueryScope

コレクション クエリのスコープが指定されたインデックスでは、特定のドキュメントの子であり、クエリ時に指定され、同じコレクション ID を持つコレクションに対してクエリを実行できます。

コレクション グループのクエリのスコープが指定されているインデックスでは、特定のドキュメントの子孫で、クエリ時に指定され、このインデックスと同じコレクション ID を持つすべてのコレクションに対してクエリを実行できます。
fields[]

IndexField

このインデックスでサポートされているフィールド。

複合インデックスの場合、これは常に 2 つ以上のフィールドです。最後のフィールド エントリは常にフィールドパス __name__ になります。作成時に、__name__ が最後のフィールドとして指定されていない場合は、最後に定義されたフィールドと同じ方向で自動的に追加されます。複合インデックスの最後のフィールドがディレクショナルでない場合、__name__ は（明示的に指定しない限り）昇順になります。

単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールドパスと同じフィールドパスを持つ 1 つのエントリになります。
state

State

出力のみ。インデックスの提供状態。

IndexField

インデックス内のフィールド。field_path は、どのフィールドにインデックスが付けられるかを示します。value_mode は、フィールド値がどのようにインデックス付けされるかを示します。

フィールド
field_path

string

name の場合もあります。単一フィールド インデックスの場合は、フィールド名と一致させるか、省略できます。
共用体フィールド value_mode。フィールド値にインデックスを付ける方法。value_mode は次のいずれかになります。
order

Order

このフィールドが、指定された順序による並べ替え、または =、<、<=、>、>= を使用した比較をサポートしていることを示します。
array_config

ArrayConfig

このフィールドが array_value のオペレーションをサポートしていることを示します。

ArrayConfig

サポートされている配列値の構成。

列挙型
ARRAY_CONFIG_UNSPECIFIED インデックスでは、追加の配列クエリはサポートされていません。
CONTAINS このインデックスは、配列の包含クエリをサポートしています。

注文

サポートされている順序。

列挙型
ORDER_UNSPECIFIED 順序は指定されていません。有効なオプションではありません。
ASCENDING フィールドはフィールド値の昇順で並べ替えられます。
DESCENDING フィールドは、フィールド値の降順で並べ替えられます。

QueryScope

クエリスコープは、クエリを実行するスコープを定義します。これは、StructuredQuery の from フィールドで指定されます。

列挙型
QUERY_SCOPE_UNSPECIFIED クエリのスコープが指定されていません。有効なオプションではありません。
COLLECTION コレクション クエリのスコープが指定されたインデックスでは、特定のドキュメントの子であり、クエリ時に指定され、インデックスで指定されたコレクション ID を持つコレクションに対してクエリを実行できます。
COLLECTION_GROUP コレクション グループのクエリのスコープが指定されているインデックスでは、インデックスで指定されたコレクション ID を持つすべてのコレクションに対してクエリを実行できます。

状態

インデックスの状態。インデックスの作成中、インデックスは CREATING 状態になります。インデックスが正常に作成されると、READY 状態に移行します。インデックスの作成で問題が発生すると、インデックスは NEEDS_REPAIR 状態に移行します。

列挙型
STATE_UNSPECIFIED 状態は指定されていません。
CREATING インデックスを作成しています。インデックスに対してアクティブな長時間実行オペレーションがあります。インデックスは、ドキュメントの書き込み時に更新されます。一部のインデックス データが存在する可能性があります。
READY インデックスを使用する準備ができました。インデックスは、ドキュメントの書き込み時に更新されます。インデックスは、適用先の保存されているすべてのドキュメントから完全に入力されます。
NEEDS_REPAIR インデックスの作成中に問題が発生しました。インデックスに対してアクティブな長時間実行オペレーションがなく、最後に完了した長時間実行オペレーションが失敗しました。ドキュメントの書き込み時にインデックスは更新されません。一部のインデックス データが存在する可能性があります。google.longrunning.Operations API を使用して、前回このインデックスを作成しようとしたオペレーションが失敗した理由を確認し、インデックスを再作成してください。

IndexOperationMetadata

FirestoreAdmin.CreateIndex からの結果 google.longrunning.Operation のメタデータ。

フィールド
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

このオペレーションの進行状況（バイト単位）。

ListFieldsRequest

FirestoreAdmin.ListFields のリクエスト。

フィールド
parent

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} 形式の親の名前
filter

string

リストの結果に適用するフィルタ。現在、FirestoreAdmin.ListFields は明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、フィルタを indexConfig.usesAncestorConfig:false に設定して FirestoreAdmin.ListFields を呼び出します。
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

結果の別のページをリクエストするために使用できるページトークン。空白の場合は、これが最後のページです。

OperationState

オペレーションの状態を記述します。

列挙型
OPERATION_STATE_UNSPECIFIED （指定なし）
INITIALIZING リクエストを処理する準備をしています。
PROCESSING リクエストがアクティブに処理されています。
CANCELLING ユーザーがオペレーションに対して google.longrunning.Operations.CancelOperation を呼び出した後に、リクエストがキャンセルされる処理中です。
FINALIZING リクエストは処理され、完了の段階にあります。
SUCCESSFUL リクエストが正常に完了しました。
FAILED リクエストの処理は完了しましたが、エラーが発生しました。
CANCELLED ユーザーが google.longrunning.Operations.CancelOperation を呼び出した後、リクエストのキャンセルが終了しました。

Progress

オペレーションの進行状況を記述します。作業単位は汎用的であり、Progress が使用される場所に基づいて解釈する必要があります。

フィールド
estimated_work

int64

推定された作業量。
completed_work

int64

完了した作業の量。

UpdateFieldRequest

FirestoreAdmin.UpdateField のリクエスト。

フィールド
field

Field

更新するフィールド。
update_mask

FieldMask

フィールドに対するマスク。指定すると、この field_mask で指定された構成のみがフィールドで更新されます。