FieldOperationMetadata

Metadata untuk google.longrunning.Operation hasil dari FirestoreAdmin.UpdateField.

Representasi JSON
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Kolom
startTime

string (Timestamp format)

Waktu operasi ini dimulai.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

field

string

Resource kolom yang ditindaklanjuti oleh operasi ini. Contoh: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object (IndexConfigDelta)

Daftar IndexConfigDelta, yang menjelaskan intent operasi ini.

state

enum (OperationState)

Status operasi.

progressDocuments

object (Progress)

Progres operasi ini, dalam dokumen.

progressBytes

object (Progress)

Progres operasi ini, dalam byte.

ttlConfigDelta

object (TtlConfigDelta)

Menjelaskan delta konfigurasi TTL.

IndexConfigDelta

Informasi tentang perubahan konfigurasi indeks.

Representasi JSON
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Kolom
changeType

enum (ChangeType)

Menentukan perubahan indeks.

index

object (Index)

Indeks sedang diubah.

Indeks

Indeks Cloud Firestore memungkinkan kueri sederhana dan kompleks terhadap dokumen dalam database.

Representasi JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Kolom
name

string

Hanya output. Nama yang ditentukan server untuk indeks ini. Bentuk nama untuk indeks komposit ini adalah: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Untuk indeks kolom tunggal, kolom ini akan kosong.

queryScope

enum (QueryScope)

Indeks dengan cakupan kueri koleksi yang ditentukan memungkinkan kueri terhadap koleksi yang merupakan turunan dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang sama.

Indeks dengan cakupan kueri grup koleksi yang ditentukan memungkinkan kueri terhadap semua koleksi yang berasal dari dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang sama dengan indeks ini.

apiScope

enum (ApiScope)

Cakupan API yang didukung oleh indeks ini.

fields[]

object (IndexField)

Kolom yang didukung oleh indeks ini.

Untuk indeks komposit, ini memerlukan minimal 2 kolom dan maksimal 100 kolom. Entri kolom terakhir selalu untuk jalur kolom __name__. Jika saat pembuatan, __name__ tidak ditetapkan sebagai kolom terakhir, kolom tersebut akan otomatis ditambahkan dengan arah yang sama seperti kolom terakhir yang ditentukan. Jika kolom akhir dalam indeks komposit tidak terarah, __name__ akan diurutkan ASCENDING (kecuali ditentukan secara eksplisit).

Untuk indeks kolom tunggal, ini akan selalu tepat satu entri dengan jalur kolom yang sama dengan jalur kolom dari kolom terkait.

state

enum (State)

Hanya output. Status penayangan indeks.

IndexField

Kolom dalam indeks. fieldPath menjelaskan kolom mana yang diindeks, value_mode menjelaskan cara nilai kolom diindeks.

Representasi 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.
}
Kolom
fieldPath

string

Dapat berupa name. Untuk indeks kolom tunggal, ini harus cocok dengan nama kolom atau dapat dihilangkan.

Kolom union value_mode. Cara nilai kolom diindeks. value_mode hanya ada berupa salah satu diantara berikut:
order

enum (Order)

Menunjukkan bahwa kolom ini mendukung pengurutan berdasarkan urutan yang ditentukan atau membandingkan menggunakan =, !=, <, <=, >, >=.

arrayConfig

enum (ArrayConfig)

Menunjukkan bahwa kolom ini mendukung operasi pada arrayValue.

vectorConfig

object (VectorConfig)

Menunjukkan bahwa bidang ini mendukung tetangga terdekat dan operasi jarak pada vektor.

VectorConfig

Konfigurasi indeks untuk mendukung operasi penelusuran vektor

Representasi 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.
}
Kolom
dimension

integer

Wajib. Dimensi vektor yang menerapkan konfigurasi ini.

Indeks yang dihasilkan hanya akan menyertakan vektor dari dimensi ini, dan dapat digunakan untuk penelusuran vektor dengan dimensi yang sama.

Kolom union type. Jenis indeks yang digunakan. type hanya ada berupa salah satu diantara berikut:
flat

object (FlatIndex)

Menunjukkan bahwa indeks vektor adalah indeks datar.

FlatIndex

Jenis ini tidak memiliki kolom.

Indeks yang menyimpan vektor dalam struktur data datar, dan mendukung penelusuran menyeluruh.

TtlConfigDelta

Informasi tentang perubahan konfigurasi TTL.

Representasi JSON
{
  "changeType": enum (ChangeType)
}
Kolom
changeType

enum (ChangeType)

Menentukan perubahan konfigurasi TTL.