REST Resource: projects.databases.collectionGroups.fields

Ressource: Feld

Stellt ein einzelnes Feld in der Datenbank dar.

Felder werden nach ihrer „Sammlungsgruppe“ gruppiert, die alle Sammlungen in der Datenbank mit derselben ID darstellt.

JSON-Darstellung 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Felder
name

string

Erforderlich. Einen Feldnamen im Format projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Ein Feldpfad kann ein einfacher Feldname wie address, ein Pfad zu Feldern innerhalb von „mapValue“ (z. B. address.city) oder ein spezieller Feldpfad sein. Das einzige gültige Sonderfeld ist * und steht für ein beliebiges Feld.

Feldpfade können mit (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` sowie mit symbolischen ASCII-Zeichen in Anführungszeichen gesetzt werden.

Beispiele: (Hinweis: Kommentare hier sind in Markdown-Syntax geschrieben, es gibt also eine zusätzliche Ebene mit Graviszeichen, die einen Codeblock darstellen) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, keine Felder.

Eine spezielle Field enthält die Standardeinstellungen für die Indexierung für alle Felder. Der Ressourcenname dieses Felds lautet: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Indexe, die auf diesem Field definiert sind, werden auf alle Felder angewendet, die keine eigene Field-Indexkonfiguration haben.
indexConfig

object (IndexConfig)

Die Indexkonfiguration für dieses Feld. Wenn die Richtlinie nicht konfiguriert ist, wird die Feldindexierung auf die durch ancestorField definierte Konfiguration zurückgesetzt. Wenn Sie explizit alle Indexe für dieses Feld entfernen möchten, geben Sie eine Indexkonfiguration mit einer leeren Indexliste an.
ttlConfig

object (TtlConfig)

Die TTL-Konfiguration für diesen Field. Wenn Sie dies festlegen oder die Einstellung aufheben, wird die TTL für Dokumente mit dieser Field aktiviert bzw. deaktiviert.

IndexConfig

Die Indexkonfiguration für dieses Feld.

JSON-Darstellung 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Felder
indexes[]

object (Index)

Die für dieses Feld unterstützten Indexe.
usesAncestorConfig

boolean

Nur Ausgabe Bei „true“ wird die Indexkonfiguration von Field aus der durch ancestorField angegebenen Konfiguration festgelegt. Bei „false“ wird die Indexkonfiguration des Field explizit definiert.
ancestorField

string

Nur Ausgabe Gibt den Ressourcennamen des Field an, für den die Indexkonfiguration dieses Feldes festgelegt wird (wenn usesAncestorConfig „wahr“ ist), oder von dem er festgelegt werden würde, wenn dieses Feld keine Indexkonfiguration hätte (wenn usesAncestorConfig „falsch“) ist.
reverting

boolean

Nur Ausgabe. Bei „true“ wird die Indexkonfiguration von Field zurückgesetzt. Sobald die Indexkonfiguration abgeschlossen ist, wechselt die Indexkonfiguration in den gleichen Zustand wie das durch ancestorField angegebene Feld. Dann ist usesAncestorConfig der true und reverting wird false.

TtlConfig

Die TTL-Konfiguration (Time-to-Live) für Dokumente, für die diese Field festgelegt ist.

Das Speichern eines Zeitstempelwerts in einem Feld mit aktiviertem TTL wird als absolute Ablaufzeit des Dokuments behandelt. Zeitstempelwerte in der Vergangenheit geben an, dass das Dokument für einen sofortigen Ablauf infrage kommt. Wenn Sie einen anderen Datentyp verwenden oder das Feld auslassen, wird die Ablaufzeit für das einzelne Dokument deaktiviert.

JSON-Darstellung 
{
  "state": enum (State)
}
Felder
state

enum (State)

Nur Ausgabe Der Status der TTL-Konfiguration.

Status

Der Status, nach dem die TTL-Konfiguration auf alle Dokumente angewendet wird.

Enums
STATE_UNSPECIFIED Der Status ist nicht angegeben oder unbekannt.
CREATING Die TTL wird angewendet. Es gibt einen aktiven Vorgang mit langer Ausführungszeit, um die Änderung zu verfolgen. Für neu verfasste Dokumente werden TTLs wie angefordert angewendet. Die angeforderten TTLs für vorhandene Dokumente werden noch verarbeitet. Wenn TTLs für alle vorhandenen Dokumente verarbeitet wurden, ändert sich der Status in „ACTIVE“.
ACTIVE Die TTL ist für alle Dokumente aktiv.
NEEDS_REPAIR Die TTL-Konfiguration konnte nicht für alle vorhandenen Dokumente aktiviert werden. Für neu verfasste Dokumente gilt weiterhin die TTL. Der letzte Versuch, die TTL für Field zu aktivieren, wurde zurückgegeben und enthält möglicherweise weitere Informationen.

Methoden

get

 Ruft die Metadaten und die Konfiguration für ein Feld ab.

list

 Listet die Feldkonfiguration und Metadaten für diese Datenbank auf.

patch

 Aktualisiert eine Feldkonfiguration.