Package google.firestore.admin.v1beta1

Index

FirestoreAdmin

Die Cloud Firestore Admin-API.

Diese API stellt mehrere Verwaltungsdienste für Cloud Firestore bereit.

Konzepte

Projekt, Datenbank, Namespace, Sammlung und Dokument werden wie in der Google Cloud Firestore API definiert verwendet.

Operation: Eine Operation stellt eine Arbeit dar, die im Hintergrund ausgeführt wird.

Dienstleistungen

Index

Der Indexdienst verwaltet Cloud Firestore-Indizes.

Die Indexerstellung erfolgt asynchron. Für jede solche asynchrone Operation wird eine Operationsressource erstellt. Der Status der Operation (einschließlich aller aufgetretenen Fehler) kann über die Operation-Ressource 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.

Betrieb

Die Operations-Sammlung stellt eine Aufzeichnung der für das angegebene Projekt durchgeführten Aktionen bereit (einschließlich aller laufenden Operationen). Vorgänge werden nicht direkt erstellt, sondern durch Aufrufe anderer Sammlungen oder Ressourcen.

Ein noch nicht abgeschlossener Vorgang kann abgebrochen werden. Die Abbruchanforderung ist asynchron und der Vorgang wird möglicherweise noch einige Zeit nach der Abbruchanforderung weiter ausgeführt.

Eine ausgeführte Operation kann gelöscht werden, sodass sie nicht mehr als Teil der Operation-Sammlung 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 könnte der Prozess zu einem Fehler führen. In diesem Fall wechselt der Index in den Status ERROR . Der Prozess kann wiederhergestellt werden, indem die Daten, die den Fehler verursacht haben, korrigiert, der Index mit delete entfernt und der Index dann mit create neu erstellt wird.

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

Berechtigungsbereiche

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 .

Index löschen

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

Löscht einen Index.

Berechtigungsbereiche

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 .

Dokumente exportieren

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

Exportiert eine Kopie aller oder einer Teilmenge der Dokumente aus Google Cloud Firestore in ein anderes Speichersystem, beispielsweise Google Cloud Storage. Kürzlich durchgeführte Aktualisierungen von Dokumenten werden möglicherweise nicht im Export berücksichtigt. Der Export erfolgt im Hintergrund und sein Fortschritt kann über die erstellte Operationsressource überwacht und verwaltet werden. Die Ausgabe eines Exports darf erst verwendet werden, wenn der zugehörige Vorgang abgeschlossen ist. Wenn ein Exportvorgang vor Abschluss abgebrochen wird, bleiben möglicherweise Teildaten im Google Cloud Storage zurück.

Berechtigungsbereiche

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.

Berechtigungsbereiche

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 .

Dokumente importieren

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

Importiert Dokumente in Google Cloud Firestore. Vorhandene Dokumente mit demselben Namen werden überschrieben. Der Import erfolgt im Hintergrund und sein Fortschritt kann über die erstellte Operationsressource überwacht und verwaltet werden. Wenn ein ImportDocuments-Vorgang abgebrochen wird, ist es möglich, dass eine Teilmenge der Daten bereits in Cloud Firestore importiert wurde.

Berechtigungsbereiche

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 Indizes auf, die den angegebenen Filtern entsprechen.

Berechtigungsbereiche

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. Zum Beispiel: projects/{project_id}/databases/{database_id}

index

Index

Der zu erstellende Index. Die Felder „Name“ und „Status“ werden nur ausgegeben und ignoriert. Bestimmte Einzelfeldindizes können nicht erstellt oder gelöscht werden.

DeleteIndexRequest

Die Anfrage für FirestoreAdmin.DeleteIndex .

Felder
name

string

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

ExportDocumentsMetadata

Metadaten für ExportDocuments-Vorgänge.

Felder
start_time

Timestamp

Der Zeitpunkt, als mit der Operation begonnen wurde.

end_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang erfolgreich oder nicht erfolgreich beendet wurde. Deaktivieren Sie diese Option, 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 Bytes.

collection_ids[]

string

Welche Sammlungs-IDs werden exportiert?

output_uri_prefix

string

Wohin die Entitäten exportiert werden.

ExportDocumentsRequest

Die Anfrage für FirestoreAdmin.ExportDocuments .

Felder
name

string

Datenbank zum Exportieren. Sollte die Form haben: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Welche Sammlungs-IDs exportiert werden sollen. Nicht spezifiziert bedeutet alle Sammlungen.

output_uri_prefix

string

Der Ausgabe-URI. Unterstützt derzeit nur Google Cloud Storage-URIs der Form: gs://BUCKET_NAME[/NAMESPACE_PATH] , 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 Auswahl eines Namens unbedingt die Benennungsrichtlinien von Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Wenn es sich bei dem URI um einen Bucket (ohne Namespace-Pfad) handelt, wird basierend auf der Startzeit ein Präfix generiert.

ExportDocumentsResponse

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

Felder
output_uri_prefix

string

Speicherort der Ausgabedateien. Dies kann verwendet werden, um einen Import in Cloud Firestore (dieses Projekt oder ein anderes Projekt) zu starten, nachdem der Vorgang erfolgreich abgeschlossen wurde.

GetIndexRequest

Die Anfrage für FirestoreAdmin.GetIndex .

Felder
name

string

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

ImportDocumentsMetadata

Metadaten für ImportDocuments-Vorgänge.

Felder
start_time

Timestamp

Der Zeitpunkt, als mit der Operation begonnen wurde.

end_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang erfolgreich oder nicht erfolgreich beendet wurde. Deaktivieren Sie diese Option, 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 Bytes.

collection_ids[]

string

Welche Sammlungs-IDs werden importiert?

input_uri_prefix

string

Der Speicherort der importierten Dokumente.

ImportDocumentsRequest

Die Anfrage für FirestoreAdmin.ImportDocuments .

Felder
name

string

Datenbank zum Importieren. Sollte die Form haben: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Welche Sammlungs-IDs importiert werden sollen. Nicht angegeben bedeutet, dass alle im Import enthaltenen Sammlungen enthalten sind.

input_uri_prefix

string

Speicherort der exportierten Dateien. Dies muss mit dem „output_uri_prefix“ einer „ExportDocumentsResponse“ aus einem Export übereinstimmen, der erfolgreich abgeschlossen wurde. Siehe: 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 indizierenden Felder.

state

State

Der Status des Index. Nur Ausgabe.

Zustand

Der Status eines Index. Während der Indexerstellung befindet sich ein Index im 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 .

Aufzählungen
STATE_UNSPECIFIED Der Staat ist nicht spezifiziert.
CREATING Der Index wird erstellt. Für den Index ist ein aktiver, lang andauernder Vorgang vorhanden. Der Index wird beim Schreiben eines Dokuments aktualisiert. Möglicherweise sind einige Indexdaten vorhanden.
READY Der Index ist einsatzbereit. Der Index wird beim Schreiben eines Dokuments aktualisiert. Der Index wird vollständig mit allen gespeicherten Dokumenten gefüllt, auf die er sich bezieht.
ERROR Der Index wurde erstellt, aber es ist ein Fehler aufgetreten. Für den Index ist kein aktiver Langzeitvorgang vorhanden und der zuletzt abgeschlossene Langzeitvorgang ist fehlgeschlagen. Der Index wird beim Schreiben eines Dokuments nicht aktualisiert. Möglicherweise sind einige Indexdaten vorhanden.

IndexField

Ein Feld eines Index.

Felder
field_path

string

Der Weg des Feldes. Muss mit der in [google.firestore.v1beta1.Document.fields][fields] beschriebenen Feldpfadspezifikation übereinstimmen. Der spezielle Feldpfad __name__ kann einzeln oder am Ende eines Pfads verwendet werden. __type__ darf nur am Ende des Pfads verwendet werden.

mode

Mode

Der Modus des Feldes.

Modus

Der Modus bestimmt, wie ein Feld indiziert wird.

Aufzählungen
MODE_UNSPECIFIED Der Modus ist nicht spezifiziert.
ASCENDING Die Werte des Feldes werden indiziert, um die Reihenfolge in aufsteigender Reihenfolge und die Abfrage nach <, >, <=, >= und = zu unterstützen.
DESCENDING Die Werte des Feldes werden indiziert, um die Reihenfolge in absteigender Reihenfolge und auch die Abfrage nach <, >, <=, >= und = zu unterstützen.
ARRAY_CONTAINS Die Array-Werte des Felds werden indiziert, um die Mitgliedschaft mithilfe von ARRAY_CONTAINS-Abfragen zu unterstützen.

IndexOperationMetadata

Metadaten für Indexvorgänge. Diese Metadaten füllen das Metadatenfeld von google.longrunning.Operation aus.

Felder
start_time

Timestamp

Der Zeitpunkt, als mit der Operation begonnen wurde.

end_time

Timestamp

Der Zeitpunkt, zu dem der Vorgang erfolgreich oder nicht erfolgreich beendet wurde. Deaktivieren Sie diese Option, wenn der Vorgang noch aktiv ist.

index

string

Die Indexressource, auf die dieser Vorgang wirkt. Zum Beispiel: projects/{project_id}/databases/{database_id}/indexes/{index_id}

operation_type

OperationType

Der Typ des Indexvorgangs.

cancelled

bool

True, wenn die google.longrunning.Operation abgebrochen wurde. Wenn der Abbruch ausgeführt wird, ist cancelled wahr, google.longrunning.Operation.done jedoch false.

document_progress

Progress

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

Operationstyp

Der Typ des Indexvorgangs.

Aufzählungen
OPERATION_TYPE_UNSPECIFIED Nicht spezifiziert. Wird niemals vom Server festgelegt.
CREATING_INDEX Der Vorgang erstellt den Index. Initiiert durch einen CreateIndex Aufruf.

ListIndexesRequest

Die Anfrage für FirestoreAdmin.ListIndexes .

Felder
parent

string

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

filter

string

page_size

int32

Die Standardseitengröße der Liste.

page_token

string

Das Standard-Listenseiten-Token.

ListIndexesResponse

Die Antwort für FirestoreAdmin.ListIndexes .

Felder
indexes[]

Index

Die Indizes.

next_page_token

string

Das Standard-Token „Nächste Seite auflisten“.

Standortmetadaten

Dieser Typ hat keine Felder.

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

OperationsState

Die verschiedenen möglichen Zustände für einen laufenden Betrieb.

Aufzählungen
STATE_UNSPECIFIED Nicht spezifiziert.
INITIALIZING Die Anfrage wird zur Bearbeitung vorbereitet.
PROCESSING Die Anfrage wird aktiv bearbeitet.
CANCELLING Die Anfrage wird gerade abgebrochen, nachdem der Benutzer google.longrunning.Operations.CancelOperation für den Vorgang aufgerufen hat.
FINALIZING Die Anfrage wurde bearbeitet und befindet sich in der Abschlussphase.
SUCCESSFUL Die Anfrage wurde erfolgreich abgeschlossen.
FAILED Die Verarbeitung der Anfrage wurde abgeschlossen, es ist jedoch ein Fehler aufgetreten.
CANCELLED Der Abbruch der Anfrage wurde abgeschlossen, nachdem der Benutzer google.longrunning.Operations.CancelOperation aufgerufen hat.

Fortschritt

Misst den Fortschritt einer bestimmten Metrik.

Felder
work_completed

int64

Eine Schätzung, wie viel Arbeit abgeschlossen wurde. Beachten Sie, dass dies möglicherweise größer als work_estimated ist.

work_estimated

int64

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