Package google.firestore.admin.v1beta1

Index

FirestoreAdmin

Cloud Firestore Admin API

Diese API bietet mehrere Verwaltungsdienste für Cloud Firestore.

Konzepte

Projekt, Datenbank, Namespace, Sammlung 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.

Dienste

Index

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.

Metadaten

Stellt Metadaten und statistische Informationen zu Daten in Cloud Firestore bereit. Die im Rahmen dieser API bereitgestellten Daten sind möglicherweise veraltet.

Vorgang

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 noch nicht abgeschlossener Vorgang kann abgebrochen werden. Die Abbruchanfrage ist asynchron und der Vorgang wird möglicherweise noch einige Zeit nach der Anfrage zum Abbruch ausgeführt.

Ein abgeschlossener Vorgang kann gelöscht werden, sodass er nicht mehr als Teil der Sammlung "Vorgang" aufgeführt wird.

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Erstellt den angegebenen Index. Der Anfangszustand eines neu erstellten Index ist CREATING. Nach Abschluss der zurückgegebenen google.longrunning.Operation lautet der Status READY. Wenn der Index bereits vorhanden ist, gibt der Aufruf den Status ALREADY_EXISTS zurück.

Während der Erstellung kann der Prozess zu einem Fehler führen. In diesem Fall wird der Index in den Status ERROR versetzt. Sie können den Vorgang wiederherstellen, indem Sie die Daten, die den Fehler verursacht haben, korrigieren, den Index mit delete entfernen und ihn dann mit create neu erstellen.

Indexe mit einem einzelnen Feld können nicht erstellt werden.

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

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Listet die Indexe auf, die den angegebenen Filtern entsprechen.

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.

CreateIndexRequest

Die Anfrage für FirestoreAdmin.CreateIndex.

Felder
parent

string

Der Name der Datenbank, für die dieser Index gilt. Beispiel: projects/{project_id}/databases/{database_id}
index

Index

Der zu erstellende Index. Die Felder „name“ und „state“ werden nur ausgegeben und werden ignoriert. Bestimmte Einzelfeldindexe können nicht erstellt oder gelöscht werden.

DeleteIndexRequest

Die Anfrage für FirestoreAdmin.DeleteIndex.

Felder
name

string

Der Indexname. Beispiel: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadaten für ExportDocuments-Vorgänge.

Felder
start_time

Timestamp

Der Zeitpunkt, zu dem die Arbeit am Vorgang begann.
end_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang beendet wurde, entweder erfolgreich oder anderweitig. Wird aufgehoben, wenn der Vorgang noch aktiv ist.
operation_state

OperationState

Der Status des Exportvorgangs.
progress_documents

Progress

Eine Schätzung der Anzahl der verarbeiteten Dokumente.
progress_bytes

Progress

Eine Schätzung der Anzahl der verarbeiteten Byte.
collection_ids[]

string

Die zu exportierenden Sammlungs-IDs
output_uri_prefix

string

Das Ziel, in das die Entitäten exportiert werden.

ExportDocumentsRequest

Die Anfrage für FirestoreAdmin.ExportDocuments.

Felder
name

string

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.

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.

GetIndexRequest

Die Anfrage für FirestoreAdmin.GetIndex.

Felder
name

string

Der Name des Index. Beispiel: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

Metadaten für ImportDocuments-Vorgänge.

Felder
start_time

Timestamp

Der Zeitpunkt, zu dem die Arbeit am Vorgang begann.
end_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang beendet wurde, entweder erfolgreich oder anderweitig. Wird aufgehoben, wenn der Vorgang noch aktiv ist.
operation_state

OperationState

Der Status des Importvorgangs.
progress_documents

Progress

Eine Schätzung der Anzahl der verarbeiteten Dokumente.
progress_bytes

Progress

Eine Schätzung der Anzahl der verarbeiteten Byte.
collection_ids[]

string

Die zu importierenden Sammlungs-IDs
input_uri_prefix

string

Der Speicherort der zu importierenden Dokumente.

ImportDocumentsRequest

Die Anfrage für FirestoreAdmin.ImportDocuments.

Felder
name

string

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.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Index

Eine Indexdefinition.

Felder
name

string

Der Ressourcenname des Index. Nur Ausgabe
collection_id

string

Die Sammlungs-ID, für die dieser Index gilt. Erforderlich.
fields[]

IndexField

Die zu indexierenden Felder.
state

State

Der Status des Index. Nur Ausgabe

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 der Index nicht erstellt werden kann, wechselt er in den Status ERROR.

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

IndexField

Feld eines Index.

Felder
field_path

string

Der Pfad des Felds. Muss mit der Spezifikation des Feldpfads übereinstimmen, die in [google.firestore.v1beta1.Document.fields][fields] beschrieben wird. Der spezielle Feldpfad __name__ kann allein oder am Ende eines Pfads verwendet werden. __type__ darf nur am Ende des Pfads verwendet werden.
mode

Mode

Der Modus des Felds.

Modus

Der Modus bestimmt, wie ein Feld indexiert wird.

Enums
MODE_UNSPECIFIED Der Modus ist nicht angegeben.
ASCENDING Die Werte des Felds sind indexiert, um eine Sequenzierung in aufsteigender Reihenfolge und eine Abfrage nach <, >, <=, >= und = zu unterstützen.
DESCENDING Die Feldwerte sind indexiert, um eine Sequenzierung in absteigender Reihenfolge zu unterstützen und auch Abfragen nach <, >, <=, >= und = zu ermöglichen.
ARRAY_CONTAINS Die Arraywerte des Feldes sind indexiert, um die Mitgliedschaft bei ARRAY_CONTAINS-Abfragen zu unterstützen.

IndexOperationMetadata

Metadaten für Indexvorgänge. Diese Metadaten werden in das Metadatenfeld von google.longrunning.Operation eingetragen.

Felder
start_time

Timestamp

Der Zeitpunkt, zu dem die Arbeit am Vorgang begann.
end_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang beendet wurde, entweder erfolgreich oder anderweitig. Wird aufgehoben, wenn der Vorgang noch aktiv ist.
index

string

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

OperationType

Der Typ des Indexvorgangs.
cancelled

bool

„True“, wenn google.longrunning.Operation abgebrochen wurde. Wenn der Abbruch in Bearbeitung ist, ist der abgebrochene Wert „true“, aber „google.longrunning.Operation.done“ ist „false“.
document_progress

Progress

Fortschritt des vorhandenen Vorgangs, gemessen in der Anzahl der Dokumente.

OperationType

Der Typ des Indexvorgangs.

Enums
OPERATION_TYPE_UNSPECIFIED Nicht angegeben Nie vom Server festgelegt.
CREATING_INDEX Durch den Vorgang wird der Index erstellt. Ausgelöst durch einen CreateIndex-Anruf.

ListIndexesRequest

Die Anfrage für FirestoreAdmin.ListIndexes.

Felder
parent

string

Der Datenbankname. Beispiel: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

Die Standardgröße für die Listenseite.
page_token

string

Das Standardtoken der Listenseite.

ListIndexesResponse

Die Antwort für FirestoreAdmin.ListIndexes.

Felder
indexes[]

Index

Die Indexe.
next_page_token

string

Das Standardtoken für die nächste Listenseite.

LocationMetadata

Dieser Typ hat keine Felder.

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

OperationState

Die verschiedenen möglichen Status für einen laufenden Vorgang.

Enums
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

Misst den Fortschritt eines bestimmten Messwerts.

Felder
work_completed

int64

Eine Schätzung, wie viel Arbeit abgeschlossen wurde. Dieser Wert kann größer als work_estimated sein.
work_estimated

int64

Eine Schätzung, wie viel Arbeit erledigt werden muss. Null, wenn die Arbeitsschätzung nicht verfügbar ist. Kann sich im Laufe der Arbeit ändern.