Package google.firestore.admin.v1

Index

FirestoreAdmin

Cloud Firestore Admin API

Diese API bietet mehrere Verwaltungsdienste für Cloud Firestore.

„Projekt“, „Datenbank“, „Namespace“, „Sammlung“, „Sammlungsgruppe“ und „Dokument“ werden gemäß der Definition in der Google Cloud Firestore API verwendet.

Vorgang: Ein Vorgang stellt eine Arbeit dar, die im Hintergrund ausgeführt wird.

Der Indexdienst verwaltet Cloud Firestore-Indexe.

Die Indexerstellung erfolgt asynchron. Für jeden solchen asynchronen Vorgang wird eine Vorgangsressource erstellt. Der Status des Vorgangs, einschließlich aller aufgetretenen Fehler, kann über die Vorgangsressource abgefragt werden.

Die Sammlung „Vorgänge“ enthält eine Aufzeichnung der Aktionen, die für das angegebene Projekt ausgeführt wurden, einschließlich aller laufenden Vorgänge. Vorgänge werden nicht direkt erstellt, sondern durch Aufrufe anderer Sammlungen oder Ressourcen.

Ein abgeschlossener Vorgang kann gelöscht werden, sodass er nicht mehr als Teil der Sammlung "Vorgang" aufgeführt wird. Bei Vorgängen handelt es sich um eine automatische Speicherbereinigung nach 30 Tagen. Standardmäßig gibt ListOperations nur laufende und fehlgeschlagene Vorgänge zurück. Um abgeschlossene Vorgänge aufzulisten, senden Sie eine ListOperations-Anfrage mit dem Filter done: true.

Vorgänge werden vom Dienst FirestoreAdmin erstellt, der Zugriff erfolgt jedoch über den Dienst google.longrunning.Operations.

CreateBackupSchedule

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

Erstellt einen Sicherungszeitplan für eine Datenbank. Für eine Datenbank können maximal zwei Sicherungspläne konfiguriert werden: ein täglicher Sicherungszeitplan mit einer Aufbewahrung von bis zu 7 Tagen und ein wöchentlicher Sicherungszeitplan mit einer Aufbewahrung von bis zu 14 Wochen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

CreateDatabase

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

Datenbank erstellen

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Erstellt einen zusammengesetzten Index. Dadurch wird ein google.longrunning.Operation zurückgegeben, mit dem der Status der Erstellung verfolgt werden kann. Die Metadaten für den Vorgang sind vom Typ IndexOperationMetadata.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

DeleteBackup

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

Löscht eine Sicherung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

DeleteBackupSchedule

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

Löscht einen Sicherungszeitplan.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

DeleteDatabase

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

Löscht eine Datenbank.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Löscht einen zusammengesetzten Index.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Exportiert eine Kopie aller oder eines Teils von Dokumenten von Google Cloud Firestore in ein anderes Speichersystem wie Google Cloud Storage. Kürzlich an Dokumenten vorgenommene Aktualisierungen werden möglicherweise nicht im Export berücksichtigt. Der Export wird im Hintergrund ausgeführt und der Fortschritt kann über die erstellte Vorgangsressource überwacht und verwaltet werden. Die Ausgabe eines Exports kann erst verwendet werden, nachdem der zugehörige Vorgang abgeschlossen ist. Wenn ein Exportvorgang vor dem Abschluss abgebrochen wird, bleiben möglicherweise unvollständige Daten in Google Cloud Storage erhalten.

Weitere Informationen zum Exportverhalten und zum Ausgabeformat finden Sie unter https://cloud.google.com/firestore/docs/manage-data/export-import.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

GetBackup

rpc GetBackup(GetBackupRequest) returns (Backup)

Ruft Informationen zu einer Sicherung ab.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

GetBackupSchedule

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

Ruft Informationen zu einem Sicherungszeitplan ab.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

GetDatabase

rpc GetDatabase(GetDatabaseRequest) returns (Database)

Ruft Informationen zu einer Datenbank ab.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

GetField

rpc GetField(GetFieldRequest) returns (Field)

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

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Ruft einen zusammengesetzten Index ab.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Importiert Dokumente in Google Cloud Firestore. Vorhandene Dokumente mit demselben Namen werden überschrieben. Der Import wird im Hintergrund ausgeführt und der Fortschritt kann über die erstellte Vorgangsressource überwacht und verwaltet werden. Wenn ein ImportDocuments-Vorgang abgebrochen wird, wurde möglicherweise bereits ein Teil der Daten in Cloud Firestore importiert.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ListBackupSchedules

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

Sicherungspläne auflisten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ListBackups

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

Listet alle Sicherungen auf.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ListDatabases

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

Alle Datenbanken im Projekt auflisten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

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

Derzeit unterstützt FirestoreAdmin.ListFields nur das Auflisten von Feldern, die explizit überschrieben wurden. Um diese Abfrage zu erstellen, rufen Sie FirestoreAdmin.ListFields auf und setzen Sie den Filter auf indexConfig.usesAncestorConfig:false oder ttlConfig:*.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Listet zusammengesetzte Indexe auf.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

RestoreDatabase

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

Erstellt eine neue Datenbank durch Wiederherstellung aus einer vorhandenen Sicherung.

Die neue Datenbank muss sich in derselben Cloud-Region oder am multiregionalen Standort wie die vorhandene Sicherung befinden. Das Verhalten ähnelt [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], mit dem Unterschied, dass anstelle einer neuen leeren Datenbank eine neue Datenbank mit dem Datenbanktyp, der Indexkonfiguration und Dokumenten aus einer vorhandenen Sicherung erstellt wird.

Mit long-running operation kann der Fortschritt der Wiederherstellung verfolgt werden. Der Feldtyp metadata des Vorgangs ist RestoreDatabaseMetadata. Bei einer erfolgreichen Wiederherstellung ist der Typ response der Database. Die neue Datenbank kann erst gelesen oder beschreibt werden, wenn der LRO abgeschlossen ist.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

UpdateBackupSchedule

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

Aktualisiert einen Sicherungszeitplan.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

UpdateDatabase

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

Aktualisiert eine Datenbank.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Aktualisiert eine Feldkonfiguration. Derzeit gelten Feldaktualisierungen nur für die Einzelfeldindexkonfiguration. Aufrufe von FirestoreAdmin.UpdateField sollten jedoch eine Feldmaske angeben, um eine Änderung von Konfigurationen zu vermeiden, die dem Aufrufer nicht bekannt sind. Die Feldmaske sollte so angegeben werden: { paths: "index_config" }.

Dieser Aufruf gibt ein google.longrunning.Operation zurück, mit dem der Status der Feldaktualisierung verfolgt werden kann. Die Metadaten für den Vorgang sind vom Typ FieldOperationMetadata.

Verwenden Sie zum Konfigurieren der Standardfeldeinstellungen für die Datenbank die spezielle Field mit dem Ressourcennamen projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

Sicherung

Sicherung einer Cloud Firestore-Datenbank.

Die Sicherung enthält alle Dokumente und Indexkonfigurationen für die gegebene Datenbank zu einem bestimmten Zeitpunkt.

Felder
name

string

Nur Ausgabe Der eindeutige Ressourcenname der Sicherung.

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

database

string

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

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

database_uid

string

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

snapshot_time

Timestamp

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

expire_time

Timestamp

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

state

State

Nur Ausgabe Der aktuelle Status der Sicherung.

Status

Gibt den aktuellen Status der Sicherung an.

Enums
STATE_UNSPECIFIED Der Status ist nicht angegeben.
CREATING Die ausstehende Sicherung wird gerade erstellt. Vorgänge für die Sicherung werden in diesem Status abgelehnt.
READY Die Sicherung ist abgeschlossen und einsatzbereit.
NOT_AVAILABLE Die Sicherung ist momentan nicht verfügbar.

BackupSchedule

Ein Sicherungszeitplan für eine Cloud Firestore-Datenbank.

Diese Ressource gehört der Datenbank, die gesichert wird, und wird zusammen mit der Datenbank gelöscht. Die eigentlichen Sicherungen sind es jedoch nicht.

Felder
name

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}

create_time

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.

update_time

Timestamp

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

retention

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.

Union-Feld recurrence. Ein oneof-Feld, das angibt, wann Sicherungen erstellt werden. Für recurrence ist nur einer der folgenden Werte zulässig:
daily_recurrence

DailyRecurrence

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

weekly_recurrence

WeeklyRecurrence

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

CreateBackupScheduleRequest

Die Anfrage für FirestoreAdmin.CreateBackupSchedule.

Felder
parent

string

Erforderlich. Die übergeordnete Datenbank.

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

backup_schedule

BackupSchedule

Erforderlich. Der zu erstellende Sicherungszeitplan.

CreateDatabaseMetadata

Dieser Typ hat keine Felder.

Metadaten, die sich auf den Datenbankerstellungsvorgang beziehen.

CreateDatabaseRequest

Die Anfrage für FirestoreAdmin.CreateDatabase.

Felder
parent

string

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

database

Database

Erforderlich. Die zu erstellende Datenbank.

database_id

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.

CreateIndexRequest

Die Anfrage für FirestoreAdmin.CreateIndex.

Felder
parent

string

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

index

Index

Erforderlich. Zusammengesetzter Index, der erstellt werden soll

DailyRecurrence

Dieser Typ hat keine Felder.

Stellt einen wiederkehrenden Zeitplan dar, der jeden Tag zu einer bestimmten Uhrzeit ausgeführt wird.

Die Zeitzone ist UTC.

Datenbank

Eine Cloud Firestore-Datenbank.

Felder
name

string

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

uid

string

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

create_time

Timestamp

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

update_time

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.

location_id

string

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

type

DatabaseType

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

concurrency_mode

ConcurrencyMode

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

version_retention_period

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.

earliest_version_time

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.

point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

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

app_engine_integration_mode

AppEngineIntegrationMode

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

key_prefix

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).

delete_protection_state

DeleteProtectionState

Status des Löschschutzes für die Datenbank.

etag

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.

AppEngineIntegrationMode

Der Typ des App Engine-Integrationsmodus.

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Nicht verwendet.
ENABLED Wenn eine App Engine-Anwendung in derselben Region wie diese Datenbank vorhanden ist, wirkt sich die App Engine-Konfiguration auf diese Datenbank aus. Dazu gehört das Deaktivieren der Anwendung und Datenbank sowie das Deaktivieren von Schreibvorgängen in die Datenbank.
DISABLED

App Engine hat keine Auswirkungen auf die Fähigkeit dieser Datenbank, Anfragen zu verarbeiten.

Dies ist die Standardeinstellung für Datenbanken, die mit der Firestore API erstellt wurden.

ConcurrencyMode

Der Typ des Nebenläufigkeitskontrollmodus für Transaktionen.

Enums
CONCURRENCY_MODE_UNSPECIFIED Nicht verwendet.
OPTIMISTIC Verwenden Sie standardmäßig eine optimistische Gleichzeitigkeitserkennung. Dieser Modus ist für Cloud Firestore-Datenbanken verfügbar.
PESSIMISTIC

Verwenden Sie standardmäßig die pessimistische Gleichzeitigkeitserkennung. Dieser Modus ist für Cloud Firestore-Datenbanken verfügbar.

Dies ist die Standardeinstellung für Cloud Firestore.

OPTIMISTIC_WITH_ENTITY_GROUPS

Verwenden Sie standardmäßig optimistische Gleichzeitigkeitserkennung mit Entitätsgruppen.

Dies ist der einzige verfügbare Modus für Cloud Datastore.

Dieser Modus ist auch für Cloud Firestore mit Datastore-Modus verfügbar, wird aber nicht empfohlen.

DatabaseType

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

Modusänderungen sind nur zulässig, wenn die Datenbank leer ist.

Enums
DATABASE_TYPE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Datenbanktyp weggelassen wird.
FIRESTORE_NATIVE Nativer Firestore-Modus
DATASTORE_MODE Firestore im Datastore-Modus

DeleteProtectionState

Der Löschschutzstatus der Datenbank.

Enums
DELETE_PROTECTION_STATE_UNSPECIFIED Der Standardwert. Löschschutztyp ist nicht angegeben
DELETE_PROTECTION_DISABLED Löschschutz ist deaktiviert
DELETE_PROTECTION_ENABLED Löschschutz ist aktiviert

PointInTimeRecoveryEnablement

Aktivierung der Funktion zur Wiederherstellung zu einem bestimmten Zeitpunkt.

Enums
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Nicht verwendet.
POINT_IN_TIME_RECOVERY_ENABLED

Lesevorgänge werden für ausgewählte Versionen der Daten der letzten 7 Tage unterstützt:

  • Liest aus einem beliebigen Zeitstempel innerhalb der letzten Stunde
  • Liest aus 1-minütigen Snapshots mehr als eine Stunde und innerhalb von 7 Tagen

Mit version_retention_period und earliest_version_time können Sie die unterstützten Versionen ermitteln.

POINT_IN_TIME_RECOVERY_DISABLED Lesevorgänge werden für jede Version der Daten innerhalb der letzten Stunde unterstützt.

DeleteBackupRequest

Die Anfrage für FirestoreAdmin.DeleteBackup.

Felder
name

string

Erforderlich. Name der zu löschenden Sicherung.

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

DeleteBackupScheduleRequest

Die Anfrage für [FirestoreAdmin.DeleteBackupSchedules][].

Felder
name

string

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

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

DeleteDatabaseMetadata

Dieser Typ hat keine Felder.

Metadaten, die sich auf den Datenbanklöschvorgang beziehen.

DeleteDatabaseRequest

Die Anfrage für FirestoreAdmin.DeleteDatabase.

Felder
name

string

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

etag

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.

DeleteIndexRequest

Die Anfrage für FirestoreAdmin.DeleteIndex.

Felder
name

string

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

ExportDocumentsMetadata

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

Felder
start_time

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

end_time

Timestamp

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

operation_state

OperationState

Der Status des Exportvorgangs.

progress_documents

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

progress_bytes

Progress

Der Fortschritt dieses Vorgangs in Byte.

collection_ids[]

string

Die zu exportierenden Sammlungs-IDs

output_uri_prefix

string

Das Ziel, in das die Dokumente exportiert werden.

namespace_ids[]

string

Welche Namespace-IDs exportiert werden.

snapshot_time

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.

ExportDocumentsRequest

Die Anfrage für FirestoreAdmin.ExportDocuments.

Felder
name

string

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

collection_ids[]

string

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

output_uri_prefix

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.

namespace_ids[]

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.

snapshot_time

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.

ExportDocumentsResponse

Wird im Antwortfeld google.longrunning.Operation zurückgegeben.

Felder
output_uri_prefix

string

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

Field

Stellt ein einzelnes Feld in der Datenbank dar.

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

Felder
name

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.

index_config

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.

ttl_config

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.

Felder
indexes[]

Index

Die für dieses Feld unterstützten Indexe.

uses_ancestor_config

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.

ancestor_field

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.

reverting

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.

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.

Felder
state

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.

FieldOperationMetadata

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

Felder
start_time

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

end_time

Timestamp

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

field

string

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

index_config_deltas[]

IndexConfigDelta

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

state

OperationState

Status des Vorgangs.

progress_documents

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

progress_bytes

Progress

Der Fortschritt dieses Vorgangs in Byte.

ttl_config_delta

TtlConfigDelta

Beschreibt die Deltas der TTL-Konfiguration.

IndexConfigDelta

Informationen zu einer Indexkonfigurationsänderung.

Felder
change_type

ChangeType

Gibt an, wie sich der Index ändert.

index

Index

Index, der geändert wird.

ChangeType

Gibt an, wie sich der Index ändert.

Enums
CHANGE_TYPE_UNSPECIFIED Die Art der Änderung ist nicht angegeben oder bekannt.
ADD Der Einzelfeldindex wird hinzugefügt.
REMOVE Der Einzelfeldindex wird entfernt.

TtlConfigDelta

Informationen zu einer Änderung der TTL-Konfiguration.

Felder
change_type

ChangeType

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

ChangeType

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

Enums
CHANGE_TYPE_UNSPECIFIED Die Art der Änderung ist nicht angegeben oder bekannt.
ADD Die TTL-Konfiguration wird hinzugefügt.
REMOVE Die TTL-Konfiguration wird entfernt.

GetBackupRequest

Die Anfrage für FirestoreAdmin.GetBackup.

Felder
name

string

Erforderlich. Name der abzurufenden Sicherung.

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

GetBackupScheduleRequest

Die Anfrage für FirestoreAdmin.GetBackupSchedule.

Felder
name

string

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

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

GetDatabaseRequest

Die Anfrage für FirestoreAdmin.GetDatabase.

Felder
name

string

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

GetFieldRequest

Die Anfrage für FirestoreAdmin.GetField.

Felder
name

string

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

GetIndexRequest

Die Anfrage für FirestoreAdmin.GetIndex.

Felder
name

string

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

ImportDocumentsMetadata

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

Felder
start_time

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

end_time

Timestamp

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

operation_state

OperationState

Der Status des Importvorgangs.

progress_documents

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

progress_bytes

Progress

Der Fortschritt dieses Vorgangs in Byte.

collection_ids[]

string

Die zu importierenden Sammlungs-IDs

input_uri_prefix

string

Der Speicherort der zu importierenden Dokumente.

namespace_ids[]

string

Welche Namespace-IDs importiert werden.

ImportDocumentsRequest

Die Anfrage für FirestoreAdmin.ImportDocuments.

Felder
name

string

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

collection_ids[]

string

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

input_uri_prefix

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.

namespace_ids[]

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.

Index

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

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/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}. Bei Einzelfeldindexen ist dieses Feld leer.

query_scope

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.

api_scope

ApiScope

Der von diesem Index unterstützte API-Bereich.

fields[]

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

State

Nur Ausgabe Der Bereitstellungsstatus des Index.

ApiScope

Der API-Bereich definiert die APIs (Firestore-nativ oder Firestore im Datastore-Modus), die für Abfragen unterstützt werden.

Enums
ANY_API Der Index kann nur von der Firestore Native Query API verwendet werden. Das ist die Standardeinstellung.
DATASTORE_MODE_API Der Index kann nur von Firestore im Datastore Mode Query API verwendet werden.

IndexField

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

Felder
field_path

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

Order

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

array_config

ArrayConfig

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

ArrayConfig

Die unterstützten Arraywertkonfigurationen.

Enums
ARRAY_CONFIG_UNSPECIFIED Der Index unterstützt keine zusätzlichen Array-Abfragen.
CONTAINS Der Index unterstützt Array-Einschließungsabfragen.

Auftrag

Die unterstützten Sortierungen.

Enums
ORDER_UNSPECIFIED Die Reihenfolge ist nicht angegeben. Keine gültige Option.
ASCENDING Das Feld wird nach aufsteigendem Feldwert sortiert.
DESCENDING Das Feld wird nach absteigendem Feldwert sortiert.

QueryScope

Der Abfragebereich definiert den Bereich, in dem eine Abfrage ausgeführt wird. Diese wird im Feld from einer StructuredQuery angegeben.

Enums
QUERY_SCOPE_UNSPECIFIED Der Abfragebereich ist nicht angegeben. Keine gültige Option.
COLLECTION 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 die vom Index angegebene Sammlungs-ID hat.
COLLECTION_GROUP Indexe, für die ein Sammlungsgruppen-Abfragebereich angegeben ist, ermöglichen Abfragen in allen Sammlungen, für die die vom Index angegebene Sammlungs-ID angegeben wurde.
COLLECTION_RECURSIVE Alle Ancestors der Sammlungen in den Index aufnehmen. Nur für Datenbanken im Datastore-Modus verfügbar.

Status

Der Status eines Index. Während der Indexerstellung hat ein Index den Status CREATING. Wenn der Index erfolgreich erstellt wurde, wechselt er in den Status READY. Wenn bei der Indexerstellung ein Problem auftritt, wechselt der Index in den Status NEEDS_REPAIR.

Enums
STATE_UNSPECIFIED Der Status ist nicht angegeben.
CREATING Der Index wird erstellt. Für den Index ist ein aktiver Vorgang mit langer Ausführungszeit vorhanden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Möglicherweise sind einige Indexdaten vorhanden.
READY Der Index kann verwendet werden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Der Index ist vollständig mit allen gespeicherten Dokumenten gefüllt, für die er gilt.
NEEDS_REPAIR Der Index wurde erstellt, aber ein Fehler ist aufgetreten. Für den Index ist kein aktiver Vorgang mit langer Ausführungszeit vorhanden und der zuletzt abgeschlossene Vorgang mit langer Ausführungszeit ist fehlgeschlagen. Der Index wird beim Schreiben eines Dokuments nicht aktualisiert. Möglicherweise sind einige Indexdaten vorhanden. Ermitteln Sie mithilfe der API „google.longrunning.Operations“, warum der Vorgang, bei dem zuletzt versucht wurde, diesen Index zu erstellen, fehlgeschlagen ist. Erstellen Sie dann den Index neu.

IndexOperationMetadata

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

Felder
start_time

Timestamp

Zeitpunkt, zu dem dieser Vorgang gestartet wurde.

end_time

Timestamp

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

index

string

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

state

OperationState

Status des Vorgangs.

progress_documents

Progress

Der Fortschritt dieses Vorgangs in Dokumenten.

progress_bytes

Progress

Der Fortschritt dieses Vorgangs in Byte.

ListBackupSchedulesRequest

Die Anfrage für FirestoreAdmin.ListBackupSchedules.

Felder
parent

string

Erforderlich. Die übergeordnete Datenbank.

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

ListBackupSchedulesResponse

Die Antwort für FirestoreAdmin.ListBackupSchedules.

Felder
backup_schedules[]

BackupSchedule

Liste aller Sicherungszeitpläne.

ListBackupsRequest

Die Anfrage für FirestoreAdmin.ListBackups.

Felder
parent

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.

ListBackupsResponse

Die Antwort für FirestoreAdmin.ListBackups.

Felder
backups[]

Backup

Liste aller Sicherungen für das Projekt.

unreachable[]

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.

ListDatabasesRequest

Ein Request zum Auflisten der Firestore-Datenbanken an allen Standorten eines Projekts.

Felder
parent

string

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

ListDatabasesResponse

Die Liste der Datenbanken für ein Projekt.

Felder
databases[]

Database

Die Datenbanken im Projekt.

unreachable[]

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.

ListFieldsRequest

Die Anfrage für FirestoreAdmin.ListFields.

Felder
parent

string

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

filter

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 .

page_size

int32

Die Anzahl der zurückzugebenden Ergebnisse.

page_token

string

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

ListFieldsResponse

Die Antwort für FirestoreAdmin.ListFields.

Felder
fields[]

Field

Die angeforderten Felder.

next_page_token

string

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

ListIndexesRequest

Die Anfrage für FirestoreAdmin.ListIndexes.

Felder
parent

string

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

filter

string

Der Filter, der auf die Listenergebnisse angewendet werden soll.

page_size

int32

Die Anzahl der zurückzugebenden Ergebnisse.

page_token

string

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

ListIndexesResponse

Die Antwort für FirestoreAdmin.ListIndexes.

Felder
indexes[]

Index

Die angeforderten Indexe.

next_page_token

string

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

LocationMetadata

Dieser Typ hat keine Felder.

Die Metadatennachricht für google.cloud.location.Location.metadata.

OperationState

Beschreibt den Status des Vorgangs.

Enums
OPERATION_STATE_UNSPECIFIED Nicht angegeben
INITIALIZING Die Anfrage wird für die Verarbeitung vorbereitet.
PROCESSING Die Anfrage wird aktiv verarbeitet.
CANCELLING Die Anfrage wird gerade abgebrochen, nachdem der Nutzer google.longrunning.Operations.CancelOperation für den Vorgang aufgerufen hat.
FINALIZING Die Anfrage wurde verarbeitet und befindet sich in der Abschlussphase.
SUCCESSFUL Die Anfrage wurde erfolgreich abgeschlossen.
FAILED Die Verarbeitung der Anfrage ist abgeschlossen. Es ist jedoch ein Fehler aufgetreten.
CANCELLED Das Abbrechen der Anfrage ist abgeschlossen, nachdem der Nutzer google.longrunning.Operations.CancelOperation aufgerufen hat.

Fortschritt

Beschreibt den Fortschritt des Vorgangs. Die Arbeitseinheit ist generisch und muss abhängig davon interpretiert werden, wo Progress verwendet wird.

Felder
estimated_work

int64

Der geschätzte Arbeitsaufwand.

completed_work

int64

Die Menge der abgeschlossenen Arbeit.

RestoreDatabaseMetadata

Metadaten für long-running operation aus der [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase]-Anfrage.

Felder
start_time

Timestamp

Der Zeitpunkt, zu dem die Wiederherstellung gestartet wurde.

end_time

Timestamp

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

operation_state

OperationState

Der Vorgangsstatus der Wiederherstellung.

database

string

Der Name der Datenbank, in der wiederhergestellt werden soll.

backup

string

Der Name der Sicherung, aus der wiederhergestellt wird.

progress_percentage

Progress

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

RestoreDatabaseRequest

Die Anfragenachricht für [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

Felder
parent

string

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

database_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.

Union-Feld source.

Für source ist nur einer der folgenden Werte zulässig:

backup

string

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

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

UpdateBackupScheduleRequest

Die Anfrage für FirestoreAdmin.UpdateBackupSchedule.

Felder
backup_schedule

BackupSchedule

Erforderlich. Der zu aktualisierende Sicherungszeitplan.

update_mask

FieldMask

Die Liste der Felder, die aktualisiert werden sollen.

UpdateDatabaseMetadata

Dieser Typ hat keine Felder.

Metadaten, die sich auf den Aktualisierungsvorgang der Datenbank beziehen.

UpdateDatabaseRequest

Die Anfrage für FirestoreAdmin.UpdateDatabase.

Felder
database

Database

Erforderlich. Die zu aktualisierende Datenbank.

update_mask

FieldMask

Die Liste der Felder, die aktualisiert werden sollen.

UpdateFieldRequest

Die Anfrage für FirestoreAdmin.UpdateField.

Felder
field

Field

Erforderlich. Das zu aktualisierende Feld.

update_mask

FieldMask

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

WeeklyRecurrence

Stellt einen wiederkehrenden Zeitplan dar, der an einem bestimmten Wochentag ausgeführt wird.

Die Zeitzone ist UTC.

Felder
day

DayOfWeek

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

DAY_OF_WEEK_UNSPECIFIED ist nicht zulässig.