FieldOperationMetadata

Metadaten für google.longrunning.Operation Ergebnisse von FirestoreAdmin.UpdateField.

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

string (Timestamp format)

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Wird nicht festgelegt, wenn der Vorgang noch läuft.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
field

string

Die Feldressource, auf die sich dieser Vorgang auswirkt. Beispiel: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}
indexConfigDeltas[]

object (IndexConfigDelta)

Eine Liste der IndexConfigDelta, die den Zweck dieses Vorgangs beschreiben.
state

enum (OperationState)

Status des Vorgangs.
progressDocuments

object (Progress)

Der Fortschritt dieses Vorgangs in Dokumenten.
progressBytes

object (Progress)

Der Fortschritt dieses Vorgangs in Byte.
ttlConfigDelta

object (TtlConfigDelta)

Beschreibt die Deltas der TTL-Konfiguration.

IndexConfigDelta

Informationen zu einer Indexkonfigurationsänderung.

JSON-Darstellung 
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Felder
changeType

enum (ChangeType)

Gibt an, wie sich der Index ändert.
index

object (Index)

Index, der geändert wird.

Index

Cloud Firestore-Indexe ermöglichen einfache und komplexe Abfragen von Dokumenten in einer Datenbank.

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

string

Nur Ausgabe Ein vom Server definierter Name für diesen Index. Das Format dieses Namens für zusammengesetzte Indexe sieht so aus: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}. Bei Einzelfeldindexen ist dieses Feld leer.
queryScope

enum (QueryScope)

Indexe, für die ein Sammlungsabfragebereich angegeben ist, ermöglichen Abfragen für eine Sammlung, die einem bestimmten Dokument untergeordnet ist, zum Zeitpunkt der Abfrage angegeben wurde und dieselbe Sammlungs-ID hat.

Indexe, für die ein Sammlungsgruppen-Abfragebereich angegeben ist, ermöglichen Abfragen für alle Sammlungen, die von einem bestimmten, zum Zeitpunkt der Abfrage angegebenen Dokument abstammen und dieselbe Sammlungs-ID wie dieser Index haben.
apiScope

enum (ApiScope)

Der von diesem Index unterstützte API-Bereich.
fields[]

object (IndexField)

Die von diesem Index unterstützten Felder.

Bei zusammengesetzten Indexen sind mindestens 2 und maximal 100 Felder erforderlich. Der letzte Feldeintrag bezieht sich immer auf den Feldpfad __name__. Wenn __name__ beim Erstellen nicht als letztes Feld angegeben wurde, wird es automatisch mit derselben Richtung wie das zuletzt definierte Feld hinzugefügt. Wenn das letzte Feld in einem zusammengesetzten Index nicht direktional ist, wird __name__ in aufsteigender Reihenfolge sortiert (sofern nicht ausdrücklich angegeben).

Bei Einzelfeldindexen ist dies immer genau ein Eintrag mit einem Feldpfad, der dem Feldpfad des zugehörigen Felds entspricht.
state

enum (State)

Nur Ausgabe Der Bereitstellungsstatus des Index.

IndexField

Ein Feld in einem Index. „fieldPath“ beschreibt, welches Feld indexiert wird, „value_mode“ beschreibt, wie der Feldwert indexiert wird.

JSON-Darstellung 
{
  "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.
}
Felder
fieldPath

string

Kann name sein. Bei Einzelfeldindexen muss dieser mit dem Namen des Felds übereinstimmen oder kann weggelassen werden.
Union-Feld value_mode. Wie der Feldwert indexiert wird. Für value_mode ist nur einer der folgenden Werte zulässig:
order

enum (Order)

Gibt an, dass dieses Feld die Sortierung in der angegebenen Reihenfolge oder den Vergleich mit =, !=, <, <=, >, >= unterstützt.
arrayConfig

enum (ArrayConfig)

Gibt an, dass dieses Feld Vorgänge für arrayValues unterstützt.
vectorConfig

object (VectorConfig)

Gibt an, dass dieses Feld die nächsten Nachbarn und Entfernungsoperationen für den Vektor unterstützt.

VectorConfig

Indexkonfiguration zur Unterstützung von Vektorsuchvorgängen

JSON-Darstellung 
{
  "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.
}
Felder
dimension

integer

Erforderlich. Die Vektordimension, für die diese Konfiguration gilt.

Der daraus resultierende Index enthält nur Vektoren dieser Dimension und kann für die Vektorsuche mit derselben Dimension verwendet werden.
Union-Feld type. Der verwendete Indextyp. Für type ist nur einer der folgenden Werte zulässig:
flat

object (FlatIndex)

Gibt an, dass der Vektorindex ein flacher Index ist.

FlatIndex

Dieser Typ hat keine Felder.

Index, der Vektoren in einer flachen Datenstruktur speichert und eine umfassende Suche unterstützt.

TtlConfigDelta

Informationen zu einer Änderung der TTL-Konfiguration.

JSON-Darstellung 
{
  "changeType": enum (ChangeType)
}
Felder
changeType

enum (ChangeType)

Gibt an, wie sich die TTL-Konfiguration ändert.