FieldOperationMetadata

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

JSON 表現 
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
フィールド
startTime

string (Timestamp format)

このオペレーションの開始時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

このオペレーションが完了した時刻。オペレーションがまだ進行中の場合は、設定されません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
field

string

このオペレーションの対象となるフィールド リソース。例: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}
indexConfigDeltas[]

object (IndexConfigDelta)

このオペレーションのインテントを記述する IndexConfigDelta のリスト。
state

enum (OperationState)

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

object (Progress)

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

object (Progress)

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

object (TtlConfigDelta)

TTL 構成の差分を示します。

IndexConfigDelta

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

JSON 表現 
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
フィールド
changeType

enum (ChangeType)

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

object (Index)

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

インデックス

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

JSON 表現 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
フィールド
name

string

出力専用。このインデックスのサーバー定義名。複合インデックスの場合、この名前の形式は projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} になります。単一フィールド インデックスの場合、このフィールドは空になります。
queryScope

enum (QueryScope)

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

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

enum (ApiScope)

このインデックスでサポートされている API スコープ。
fields[]

object (IndexField)

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

複合インデックスの場合、2 ～ 100 個のフィールドが必要です。最後のフィールド エントリは、常にフィールドパス __name__ のものです。作成時に __name__ が最後のフィールドとして指定されていない場合は、最後に定義されたフィールドと同じ方向で自動的に追加されます。複合インデックスの最後のフィールドに方向性がない場合、__name__ は（明示的に指定しない限り）ASCENDING に並べ替えられます。

単一フィールド インデックスの場合、これは常に 1 つのエントリであり、関連フィールドのフィールドパスと等しいフィールドパスを持ちます。
state

enum (State)

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

インデックス フィールド

インデックス内のフィールド。fieldPath はインデックス付けするフィールドを示し、value_mode はフィールド値にインデックスを付ける方法を記述します。

JSON 表現 
{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}
フィールド
fieldPath

string

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

enum (Order)

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

enum (ArrayConfig)

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

object (VectorConfig)

このフィールドでは、ベクトルに対する最近傍演算と距離演算がサポートされていることを示します。

VectorConfig

ベクトル検索オペレーションをサポートするインデックス構成

JSON 表現 
{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}
フィールド
dimension

integer

必須。この設定が適用されるベクトル ディメンション。

結果のインデックスにはこの次元のベクトルのみが含まれ、同じ次元のベクトル検索に使用できます。
共用体フィールド type。使用されるインデックスのタイプ。type は次のいずれかになります。
flat

object (FlatIndex)

ベクトル インデックスがフラット インデックスであることを示します。

フラットインデックス

この型にはフィールドがありません。

ベクトルをフラットなデータ構造に格納し、完全検索をサポートするインデックス。

TtlConfigDelta

TTL 構成の変更に関する情報。

JSON 表現 
{
  "changeType": enum (ChangeType)
}
フィールド
changeType

enum (ChangeType)

TTL 構成の変更方法を指定します。