Package google.firestore.admin.v1

string

Nur Ausgabe Der eindeutige Ressourcenname der Sicherung.

Format ist projects/{project}/locations/{location}/backups/{backup}.

string

Nur Ausgabe Name der Firestore-Datenbank, aus der die Sicherung stammt.

Format ist projects/{project}/databases/{database}.

string

Nur Ausgabe Die vom System generierte UUID4 für die Firestore-Datenbank, aus der die Sicherung stammt.

Timestamp

Nur Ausgabe Die Sicherung enthält derzeit eine extern konsistente Kopie der Datenbank.

Timestamp

Nur Ausgabe Der Zeitstempel, zu dem diese Sicherung abläuft.

State

Nur Ausgabe Der aktuelle Status der Sicherung.

string

Nur Ausgabe Die eindeutige Kennung für den Sicherungszeitplan für alle Standorte und Datenbanken des jeweiligen Projekts.

Dies wird automatisch zugewiesen.

Format: projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Timestamp

Nur Ausgabe Der Zeitstempel, zu dem dieser Sicherungszeitplan erstellt wurde und seit dem gültig ist.

Vor diesem Zeitpunkt werden keine Sicherungen für diesen Zeitplan erstellt.

Timestamp

Nur Ausgabe Der Zeitstempel, zu dem dieser Sicherungszeitplan zuletzt aktualisiert wurde. Wenn zum ersten Mal ein Sicherungszeitplan erstellt wird, entspricht dies „create_time“.

Duration

Zu welcher relativen Zeit in der Zukunft im Vergleich zum Erstellungszeitpunkt die Sicherung gelöscht werden soll, sollte die Sicherung 7 Tage lang aufbewahrt werden.

DailyRecurrence

Für einen Zeitplan, der täglich ausgeführt wird.

WeeklyRecurrence

Für einen Zeitplan, der wöchentlich an einem bestimmten Tag ausgeführt wird

string

Erforderlich. Die übergeordnete Datenbank.

projects/{project}/databases/{database} formatieren

BackupSchedule

Erforderlich. Der zu erstellende Sicherungszeitplan.

string

Erforderlich. Ein übergeordneter Name im Format projects/{project_id}

Database

Erforderlich. Die zu erstellende Datenbank.

string

Erforderlich. Die für die Datenbank zu verwendende ID, die die letzte Komponente des Ressourcennamens der Datenbank darstellt.

Dieser Wert muss zwischen 4 und 63 Zeichen lang sein. Gültige Zeichen sind /[a–z][0–9]-/, wobei das erste Zeichen ein Buchstabe und das letzte Zeichen ein Buchstabe oder eine Ziffer ist. Darf nicht UUID-ähnlicher /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ sein.

Datenbank-ID „(Standard)“ ist ebenfalls gültig.

string

Erforderlich. Ein übergeordneter Name im Format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Index

Erforderlich. Zusammengesetzter Index, der erstellt werden soll

string

Der Ressourcenname der Datenbank. Format: projects/{project}/databases/{database}

string

Nur Ausgabe Die vom System generierte UUID4 für diese Datenbank.

Timestamp

Nur Ausgabe Der Zeitstempel, zu dem diese Datenbank erstellt wurde. Datenbanken, die vor 2016 erstellt wurden, werden nicht mit create_time gefüllt.

Timestamp

Nur Ausgabe Der Zeitstempel, zu dem diese Datenbank zuletzt aktualisiert wurde. Dies gilt nur für Aktualisierungen der Datenbankressource und nicht für Daten, die in der Datenbank enthalten sind.

string

Der Speicherort der Datenbank. Verfügbare Standorte sind unter https://cloud.google.com/firestore/docs/locations aufgeführt.

DatabaseType

Der Typ der Datenbank. Informationen zur Auswahl finden Sie unter https://cloud.google.com/datastore/docs/firestore-or-datastore.

ConcurrencyMode

Der für diese Datenbank zu verwendende Nebenläufigkeitsmodus.

Duration

Nur Ausgabe Der Zeitraum, in dem frühere Versionen von Daten in der Datenbank aufbewahrt werden.

Jeder read oder query kann einen read_time in diesem Fenster angeben und liest zu diesem Zeitpunkt den Status der Datenbank.

Wenn die PITR-Funktion aktiviert ist, beträgt die Aufbewahrungsdauer 7 Tage. Andernfalls beträgt die Aufbewahrungsdauer 1 Stunde.

Timestamp

Nur Ausgabe Der früheste Zeitstempel, zu dem ältere Versionen der Daten aus der Datenbank gelesen werden können. Siehe [version_retention_period] oben; dieses Feld enthält now - version_retention_period.

Dieser Wert wird kontinuierlich aktualisiert und verfällt, sobald er abgefragt wird. Wenn Sie diesen Wert zur Wiederherstellung von Daten verwenden, müssen Sie die Zeit in dem Moment berücksichtigen, in dem der Wert abgefragt wird, bis zu dem Zeitpunkt, an dem Sie die Wiederherstellung initiieren.

PointInTimeRecoveryEnablement

Gibt an, ob die PITR-Funktion für diese Datenbank aktiviert wird.

AppEngineIntegrationMode

Der App Engine-Integrationsmodus, der für diese Datenbank verwendet werden soll.

string

Nur Ausgabe Das Schlüsselpräfix für diese Datenbank. Dieses Schlüsselpräfix wird zusammen mit der Projekt-ID ("~") verwendet, um die Anwendungs-ID zu erstellen, die von den Cloud Datastore APIs in Laufzeiten der ersten Generation von Google App Engine zurückgegeben wird.

Dieser Wert kann leer sein. In diesem Fall ist die für URL-codierte Schlüssel zu verwendende appid die Projekt-ID (z. B. foo statt v~foo).

DeleteProtectionState

Status des Löschschutzes für die Datenbank.

string

Diese Prüfsumme wird vom Server basierend auf dem Wert anderer Felder berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client vor dem Fortfahren über einen aktuellen Wert verfügt.

string

Erforderlich. Name der zu löschenden Sicherung.

Format ist projects/{project}/locations/{location}/backups/{backup}.

string

Erforderlich. Der Name des Zeitplans für die Sicherung.

projects/{project}/databases/{database}/backupSchedules/{backup_schedule} formatieren

string

Erforderlich. Einen Namen im Format projects/{project_id}/databases/{database_id}

string

Das aktuelle ETag der Datenbank. Wenn ein eTag angegeben wird, das nicht mit dem aktuellen ETag der Datenbank übereinstimmt, wird das Löschen blockiert und der Fehler FAILED_PRECONDITION ausgegeben.

string

Erforderlich. Einen Namen im Format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

Timestamp

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

OperationState

Der Status des Exportvorgangs.

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

Progress

Der Fortschritt dieses Vorgangs in Byte.

string

Die zu exportierenden Sammlungs-IDs

string

Das Ziel, in das die Dokumente exportiert werden.

string

Welche Namespace-IDs exportiert werden.

Timestamp

Der Zeitstempel, der der Version der Datenbank entspricht, die exportiert wird. Wenn kein Wert angegeben ist, gibt es keine Garantie für die Konsistenz der zu exportierenden Dokumente.

string

Erforderlich. Zu exportierende Datenbank. Muss das Format projects/{project_id}/databases/{database_id} haben.

string

Die zu exportierenden Sammlungs-IDs. „Nicht angegeben“ bedeutet alle Sammlungen.

string

Der Ausgabe-URI. Derzeit werden Google Cloud Storage-URIs im Format gs://BUCKET_NAME[/NAMESPACE_PATH] nur unterstützt, wobei BUCKET_NAME der Name des Google Cloud Storage-Buckets und NAMESPACE_PATH ein optionaler Google Cloud Storage-Namespace-Pfad ist. Beachten Sie bei der Wahl des Namens die Namensrichtlinien von Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Wenn der URI ein Bucket (ohne Namespace-Pfad) ist, wird ein Präfix auf Basis der Startzeit generiert.

string

Eine leere Liste stellt alle Namespaces dar. Dies ist die bevorzugte Verwendung für Datenbanken, die keine Namespaces verwenden.

Ein leeres Stringelement stellt den Standard-Namespace dar. Dies sollte verwendet werden, wenn die Datenbank Daten in nicht standardmäßigen Namespaces enthält, diese aber nicht einschließen möchte. Jeder Namespace in dieser Liste muss eindeutig sein.

Timestamp

Der Zeitstempel, der der Version der zu exportierenden Datenbank entspricht. Der Zeitstempel muss in der Vergangenheit liegen, auf die Minute gerundet sein und darf nicht älter als earliestVersionTime sein. Wenn angegeben, stellen die exportierten Dokumente eine einheitliche Ansicht der Datenbank zum angegebenen Zeitpunkt dar. Andernfalls gibt es keine Garantie für die Konsistenz der exportierten Dokumente.

string

Speicherort der Ausgabedateien. Damit kann nach erfolgreichem Abschluss des Vorgangs ein Import in Cloud Firestore (dieses oder ein anderes Projekt) gestartet werden.

string

Erforderlich. Einen Feldnamen im Format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Ein Feldpfad kann ein einfacher Feldname wie address, ein Pfad zu Feldern innerhalb von „map_value“ (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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Indexe, die auf diesem Field definiert sind, werden auf alle Felder angewendet, die keine eigene Field-Indexkonfiguration haben.

IndexConfig

Die Indexkonfiguration für dieses Feld. Wenn die Richtlinie nicht konfiguriert ist, wird die Feldindexierung auf die durch ancestor_field 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

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.

Index

Die für dieses Feld unterstützten Indexe.

bool

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

string

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

bool

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 ancestor_field angegebene Feld. Dann ist uses_ancestor_config der true und reverting wird false.

State

Nur Ausgabe Der Status der TTL-Konfiguration.

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

Timestamp

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

string

Die Feldressource, auf die sich dieser Vorgang auswirkt. Beispiel: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

IndexConfigDelta

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

OperationState

Status des Vorgangs.

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

Progress

Der Fortschritt dieses Vorgangs in Byte.

TtlConfigDelta

Beschreibt die Deltas der TTL-Konfiguration.

ChangeType

Gibt an, wie sich der Index ändert.

Index

Index, der geändert wird.

ChangeType

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

string

Erforderlich. Name der abzurufenden Sicherung.

Format ist projects/{project}/locations/{location}/backups/{backup}.

string

Erforderlich. Der Name des Zeitplans für die Sicherung.

projects/{project}/databases/{database}/backupSchedules/{backup_schedule} formatieren

string

Erforderlich. Einen Namen im Format projects/{project_id}/databases/{database_id}

string

Erforderlich. Einen Namen im Format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string

Erforderlich. Einen Namen im Format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

Timestamp

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

OperationState

Der Status des Importvorgangs.

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

Progress

Der Fortschritt dieses Vorgangs in Byte.

string

Die zu importierenden Sammlungs-IDs

string

Der Speicherort der zu importierenden Dokumente.

string

Welche Namespace-IDs importiert werden.

string

Erforderlich. Datenbank, in die importiert werden soll. Muss das Format projects/{project_id}/databases/{database_id} haben.

string

Die zu importierenden Sammlungs-IDs „Nicht angegeben“ bedeutet, dass alle im Import enthaltenen Sammlungen enthalten sind.

string

Speicherort der exportierten Dateien. Dieser Wert muss mit dem Wert „output_uri_prefix“ einer ExportDocumentsResponse aus einem erfolgreich abgeschlossenen Export übereinstimmen. Weitere Informationen: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

string

Eine leere Liste stellt alle Namespaces dar. Dies ist die bevorzugte Verwendung für Datenbanken, die keine Namespaces verwenden.

Ein leeres Stringelement stellt den Standard-Namespace dar. Dies sollte verwendet werden, wenn die Datenbank Daten in nicht standardmäßigen Namespaces enthält, diese aber nicht einschließen möchte. Jeder Namespace in dieser Liste muss eindeutig sein.

string

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

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

Der von diesem Index unterstützte API-Bereich.

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

Nur Ausgabe Der Bereitstellungsstatus des Index.

string

Kann name sein. Bei Einzelfeldindexen muss dieser mit dem Namen des Felds übereinstimmen oder kann weggelassen werden.

Order

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

ArrayConfig

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

VectorConfig

Gibt an, dass dieses Feld Vorgänge für den nächsten Nachbarn und Entfernungsvorgänge für den Vektor unterstützt.

int32

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.

FlatIndex

Gibt an, dass der Vektorindex ein flacher Index ist.

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

Timestamp

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

string

Die Indexressource, auf die sich dieser Vorgang auswirkt. Beispiel: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

OperationState

Status des Vorgangs.

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

Progress

Der Fortschritt dieses Vorgangs in Byte.

string

Erforderlich. Die übergeordnete Datenbank.

Format ist projects/{project}/databases/{database}.

BackupSchedule

Liste aller Sicherungszeitpläne.

string

Erforderlich. Der Speicherort, von dem aus Sicherungen aufgelistet werden sollen.

Format ist projects/{project}/locations/{location}. Verwenden Sie {location} = '-', um Sicherungen von allen Speicherorten für das angegebene Projekt aufzulisten. Dadurch können Sie Sicherungen von einem einzelnen Speicherort oder von allen Speicherorten aus auflisten.

Backup

Liste aller Sicherungen für das Projekt.

string

Liste der Speicherorte, von denen vorhandene Sicherungen nicht abgerufen werden konnten.

Anstatt alle Anfragen zu scheitern, wenn ein einzelner Standort nicht erreichbar ist, gibt diese Antwort einen Teil der Ergebnisse und eine Liste der Standorte zurück, die hier nicht erreicht werden können. Die Anfrage kann für einen einzelnen Standort wiederholt werden, um einen konkreten Fehler zu erhalten.

string

Erforderlich. Ein übergeordneter Name im Format projects/{project_id}

Database

Die Datenbanken im Projekt.

string

Falls Daten über einzelne Datenbanken nicht aufgelistet werden können, werden sie hier aufgezeichnet.

Ein Beispieleintrag könnte sein: projects/some_project/locations/some_location. Dies kann passieren, wenn die Cloud-Region, in der sich die Datenbank befindet, derzeit nicht verfügbar ist. In diesem Fall können wir nicht alle Details über die Datenbank abrufen. Wenn Sie eine ausführlichere Fehlermeldung erhalten (oder die Ressource abrufen), senden Sie eine „Get“-Anfrage für die Ressource oder eine „List“-Anfrage für den spezifischen Standort.

string

Erforderlich. Ein übergeordneter Name im Format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

Der Filter, der auf die Listenergebnisse angewendet werden soll. Derzeit unterstützt FirestoreAdmin.ListFields nur das Auflisten von Feldern, die explizit überschrieben wurden. Um diese Abfrage auszugeben, rufen Sie FirestoreAdmin.ListFields mit einem Filter auf, der indexConfig.usesAncestorConfig:false enthält .

int32

Die Anzahl der zurückzugebenden Ergebnisse.

string

Ein Seitentoken, das von einem vorherigen Aufruf an FirestoreAdmin.ListFields zurückgegeben wurde und zum Abrufen der nächsten Ergebnisseite verwendet werden kann.

Field

Die angeforderten Felder.

string

Ein Seitentoken, mit dem eine weitere Ergebnisseite angefordert werden kann. Wenn das Feld leer ist, ist dies die letzte Seite.

string

Erforderlich. Ein übergeordneter Name im Format projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

Der Filter, der auf die Listenergebnisse angewendet werden soll.

int32

Die Anzahl der zurückzugebenden Ergebnisse.

string

Ein Seitentoken, das von einem vorherigen Aufruf an FirestoreAdmin.ListIndexes zurückgegeben wurde und zum Abrufen der nächsten Ergebnisseite verwendet werden kann.

Index

Die angeforderten Indexe.

string

Ein Seitentoken, mit dem eine weitere Ergebnisseite angefordert werden kann. Wenn das Feld leer ist, ist dies die letzte Seite.

int64

Der geschätzte Arbeitsaufwand.

int64

Die Menge der abgeschlossenen Arbeit.

Timestamp

Der Zeitpunkt, zu dem die Wiederherstellung gestartet wurde.

Timestamp

Die Uhrzeit, zu der die Wiederherstellung abgeschlossen wurde; für laufende Wiederherstellungen nicht festgelegt.

OperationState

Der Vorgangsstatus der Wiederherstellung.

string

Der Name der Datenbank, in der wiederhergestellt werden soll.

string

Der Name der Sicherung, aus der wiederhergestellt wird.

Progress

Der Fortschritt der Wiederherstellung wird als geschätzter Prozentsatz der verbleibenden Zeit angegeben.

string

Erforderlich. Das Projekt, in dem die Datenbank wiederhergestellt werden soll. Format ist projects/{project_id}.

string

Erforderlich. Die für die Datenbank zu verwendende ID, die die letzte Komponente des Ressourcennamens der Datenbank darstellt. Diese Datenbank-ID darf nicht mit einer vorhandenen Datenbank verknüpft sein.

Dieser Wert muss zwischen 4 und 63 Zeichen lang sein. Gültige Zeichen sind /[a–z][0–9]-/, wobei das erste Zeichen ein Buchstabe und das letzte Zeichen ein Buchstabe oder eine Ziffer ist. Darf nicht UUID-ähnlicher /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ sein.

Datenbank-ID „(Standard)“ ist ebenfalls gültig.

string

Sicherung für Wiederherstellung. Muss aus demselben Projekt wie das übergeordnete Element stammen.

Format ist: projects/{project_id}/locations/{location}/backups/{backup}

BackupSchedule

Erforderlich. Der zu aktualisierende Sicherungszeitplan.

FieldMask

Die Liste der Felder, die aktualisiert werden sollen.

Database

Erforderlich. Die zu aktualisierende Datenbank.

FieldMask

Die Liste der Felder, die aktualisiert werden sollen.

Field

Erforderlich. Das zu aktualisierende Feld.

FieldMask

Eine Maske relativ zum Feld. Wenn angegeben, wird nur die von „field_mask“ angegebene Konfiguration im Feld aktualisiert.

DayOfWeek

Wochentag, an dem die Kampagne ausgeführt werden soll.

DAY_OF_WEEK_UNSPECIFIED ist nicht zulässig.