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 RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Waktu penyelesaian operasi ini. Tidak akan disetel jika operasi masih berlangsung.

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

field

string

Resource kolom tempat operasi ini ditindaklanjuti. 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, dalam dokumen, dari operasi ini.

progressBytes

object (Progress)

Progres, dalam byte, operasi ini.

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 bagaimana indeks berubah.

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 ini untuk indeks gabungan 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 dari dokumen tertentu, yang 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, yang 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 gabungan, parameter ini memerlukan minimal 2 dan maksimal 100 kolom. Entri kolom terakhir selalu untuk jalur kolom __name__. Jika pada saat pembuatan, __name__ tidak ditentukan sebagai kolom terakhir, kolom tersebut akan otomatis ditambahkan dengan arah yang sama dengan kolom terakhir yang ditentukan. Jika kolom terakhir dalam indeks gabungan tidak bersifat terarah, __name__ akan diurutkan menaik (kecuali jika ditetapkan secara eksplisit).

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

state

enum (State)

Hanya output. Status penayangan indeks.

KolomIndeks

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, nilainya 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 perbandingan menggunakan =, !=, <, <=, >, >=.

arrayConfig

enum (ArrayConfig)

Menunjukkan bahwa kolom ini mendukung operasi pada arrayValue.

vectorConfig

object (VectorConfig)

Menunjukkan bahwa kolom ini mendukung operasi tetangga terdekat dan 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 diisi. Dimensi vektor tempat konfigurasi ini diterapkan.

Indeks yang dihasilkan hanya akan menyertakan vektor 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 indeks vektor adalah indeks datar.

Indeks Rata

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 bagaimana konfigurasi TTL berubah.