FieldOperationMetadata

google.longrunning.OperationのメタデータはFirestoreAdmin.UpdateFieldから得られます。

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次のいずれか 1 つだけです。
order

enum ( Order )

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

arrayConfig

enum ( ArrayConfig )

このフィールドがarrayValueの操作をサポートしていることを示します。

vectorConfig

object ( 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次のいずれか 1 つだけです。
flat

object ( FlatIndex )

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

フラットインデックス

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

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

TtlConfigDelta

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

JSON表現
{
  "changeType": enum (ChangeType)
}
田畑
changeType

enum ( ChangeType )

TTL 構成がどのように変更されるかを指定します。