Package google.firestore.admin.v1

Indeks

Administrator Firestore

Interfejs Cloud Firestore Admin API.

Ten interfejs API udostępnia kilka usług administracyjnych w Cloud Firestore.

Projekt, baza danych, przestrzeń nazw, kolekcja, grupa kolekcji i dokument są używane zgodnie z definicją interfejsu Google Cloud Firestore API.

Operacja: operacja oznacza pracę wykonywaną w tle.

Usługa indeksu zarządza indeksami Cloud Firestore.

Tworzenie indeksu jest wykonywane asynchronicznie. Dla każdej takiej operacji asynchronicznej tworzony jest zasób operacji. Zapytanie o stan operacji (w tym o wszelkie napotkane błędy) może zostać wysłane za pomocą zasobu operacji.

Kolekcja Operacje zawiera rejestr działań wykonanych w danym projekcie (w tym trwające operacje). Operacje nie są tworzone bezpośrednio, lecz przez wywołania innych kolekcji lub zasobów.

Wykonana operacja może zostać usunięta, tak aby nie była już wymieniona w kolekcji operacji. Operacje to proces czyszczenia pamięci urządzenia po 30 dniach. Domyślnie ListOperations zwraca tylko w toku i nieudanych operacjach. Aby wyświetlić listę ukończonych operacji, wyślij żądanie ListOperations z użyciem filtra done: true.

Operacje są tworzone przez usługę FirestoreAdmin, ale dostęp do nich uzyskuje się przez usługę google.longrunning.Operations.

Harmonogram tworzenia kopii zapasowych

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

Tworzy harmonogram tworzenia kopii zapasowych w bazie danych. W bazie danych można skonfigurować maksymalnie 2 harmonogramy tworzenia kopii zapasowych, 1 dzienny harmonogram tworzenia kopii zapasowych i 1 tygodniowy harmonogram tworzenia kopii zapasowych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Tworzenie bazy danych

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

Utworzenie bazy danych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Utwórz indeks

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Tworzy indeks złożony. Spowoduje to zwrócenie kodu google.longrunning.Operation, którego można użyć do śledzenia stanu tworzenia. Metadane tej operacji będą typu IndexOperationMetadata.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Usuń kopię zapasową

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

Usuwa kopię zapasową.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Usuwanie harmonogramu tworzenia kopii zapasowych

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

Usuwa harmonogram tworzenia kopii zapasowych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Usuń bazę danych

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

Usuwa bazę danych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Usuń indeks

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Usuwa indeks złożony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Eksportuje kopię wszystkich lub niektórych dokumentów z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage. Ostatnie zmiany w dokumentach mogą nie zostać uwzględnione w eksporcie. Eksport odbywa się w tle, a jego postęp można monitorować i zarządzać nim za pomocą tworzonego zasobu operacji. Danych wyjściowych eksportu można użyć dopiero po zakończeniu powiązanej operacji. Jeśli operacja eksportu zostanie anulowana przed ukończeniem, może pozostawić w Google Cloud Storage częściowe dane.

Więcej informacji o działaniu eksportu i formacie wyjściowym znajdziesz na stronie https://cloud.google.com/firestore/docs/manage-data/export-import.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Pobieranie kopii zapasowej

rpc GetBackup(GetBackupRequest) returns (Backup)

Pobiera informacje o kopii zapasowej.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Harmonogram pobierania kopii zapasowej

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

Pobiera informacje o harmonogramie tworzenia kopii zapasowych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Pobieranie bazy danych

rpc GetDatabase(GetDatabaseRequest) returns (Database)

Pobiera informacje o bazie danych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
GetField

rpc GetField(GetFieldRequest) returns (Field)

Pobiera metadane i konfigurację pola.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Pobiera indeks złożony.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Importuje dokumenty do Google Cloud Firestore. Istniejące dokumenty o takiej samej nazwie zostaną zastąpione. Import odbywa się w tle, a jego postęp może być monitorowany i można nim zarządzać za pomocą tworzonego zasobu operacji. Jeśli operacja ImportDocuments zostanie anulowana, podzbiór danych może zostać już zaimportowany do Cloud Firestore.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Wyświetlanie listy harmonogramów tworzenia kopii zapasowych

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

Wyświetl harmonogramy tworzenia kopii zapasowych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Wyświetlanie listy kopii zapasowych

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

Zawiera listę wszystkich kopii zapasowych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Wyświetlanie listy baz danych

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

Wyświetl wszystkie bazy danych w projekcie.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Wyświetlanie listy pól

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

Zawiera konfigurację pól i metadane tej bazy danych.

Obecnie FirestoreAdmin.ListFields obsługuje tylko te pola, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj FirestoreAdmin.ListFields z filtrem ustawionym na indexConfig.usesAncestorConfig:false lub ttlConfig:*.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Wyświetlanie listy indeksów

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Wyświetla listę indeksów złożonych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Przywracanie bazy danych

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

Tworzy nową bazę danych przez przywrócenie danych z istniejącej kopii zapasowej.

Nowa baza danych musi znajdować się w tym samym regionie chmury lub w wielu regionach co istniejąca kopia zapasowa. Działa to podobnie jak [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], ale zamiast tworzyć nową pustą bazę danych, tworzona jest nowa baza danych o typie bazy danych, konfiguracji indeksu i dokumentach z istniejącej kopii zapasowej.

long-running operation może służyć do śledzenia postępu przywracania, a typem pola metadata operacji jest RestoreDatabaseMetadata. Jeśli przywrócenie się udało, typ response to Database. Dopóki nie zakończy się LRO, nie będzie można odczytać ani zapisać nowej bazy danych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Harmonogram tworzenia kopii zapasowej

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

Aktualizuje harmonogram tworzenia kopii zapasowych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
AktualizujBazę danych

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

Aktualizuje bazę danych.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).
Pole aktualizacji

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Aktualizuje konfigurację pola. Obecnie aktualizacje pól mają zastosowanie tylko do konfiguracji indeksu z jednym polem. Jednak wywołania funkcji FirestoreAdmin.UpdateField powinny zawierać maskę pola, aby uniknąć zmiany konfiguracji, której rozmówca nie wie. Maską pola należy określić jako: { paths: "index_config" }.

To wywołanie zwraca wartość google.longrunning.Operation, która może służyć do śledzenia stanu aktualizacji pola. Metadane tej operacji będą typu FieldOperationMetadata.

Aby skonfigurować domyślne ustawienia pola bazy danych, użyj specjalnego elementu Field o nazwie zasobu: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).

Kopia zapasowa

Kopia zapasowa bazy danych Cloud Firestore.

Kopia zapasowa zawiera wszystkie dokumenty i konfiguracje indeksów dla danej bazy danych z określonego momentu.

Pola
name

string

Tylko dane wyjściowe. Unikalna nazwa zasobu kopii zapasowej.

Format to projects/{project}/locations/{location}/backups/{backup}.
database

string

Tylko dane wyjściowe. Nazwa bazy danych Firestore, z której pochodzi kopia zapasowa.

Format to projects/{project}/databases/{database}.
database_uid

string

Tylko dane wyjściowe. Wygenerowany przez system identyfikator UUID4 bazy danych Firestore, z której pochodzi kopia zapasowa.
snapshot_time

Timestamp

Tylko dane wyjściowe. Obecnie kopia zapasowa zawiera spójną zewnętrznie kopię bazy danych.
expire_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa, kiedy ta kopia zapasowa traci ważność.
state

State

Tylko dane wyjściowe. Bieżący stan kopii zapasowej.

Stan

Wskaż bieżący stan kopii zapasowej.

Wartości w polu enum
STATE_UNSPECIFIED Stan nie jest określony.
CREATING Nadal tworzona jest oczekująca kopia zapasowa. Operacje na kopii zapasowej będą w tym stanie odrzucane.
READY Kopia zapasowa jest gotowa i gotowa do użycia.
NOT_AVAILABLE Kopia zapasowa jest obecnie niedostępna.

Harmonogram tworzenia kopii zapasowych

Harmonogram tworzenia kopii zapasowych bazy danych Cloud Firestore.

Ten zasób należy do bazy danych, której kopia zapasowa jest tworzona, i jest usuwany razem z bazą danych. Rzeczywiste kopie zapasowe to nie.

Pola
name

string

Tylko dane wyjściowe. Unikalny identyfikator harmonogramu tworzenia kopii zapasowych we wszystkich lokalizacjach i bazach danych w danym projekcie.

Zostanie ono przypisane automatycznie.

Format to projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
create_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ten harmonogram tworzenia kopii zapasowych został utworzony i obowiązuje od tego czasu.

Do tego czasu nie będą tworzone żadne kopie zapasowe dla tego harmonogramu.
update_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ten harmonogram tworzenia kopii zapasowych został ostatnio zaktualizowany. Przy pierwszym tworzeniu harmonogramu tworzenia kopii zapasowych ma on wartość równą funkcji create_time.
retention

Duration

W jakim momencie w przyszłości (np.w porównaniu z czasem utworzenia kopii zapasowej) ma zostać usunięta, np. przechowywać kopie zapasowe przez 7 dni.

Maksymalny obsługiwany okres przechowywania to 14 tygodni.
Pole sumy recurrence. Jedno pole do reprezentowania czasu wykonywania kopii zapasowych. recurrence może mieć tylko jedną z tych wartości:
daily_recurrence

DailyRecurrence

W przypadku harmonogramu uruchamianego codziennie.
weekly_recurrence

WeeklyRecurrence

Do harmonogramu uruchamianego co tydzień w określony dzień.

Utworzenie żądania planowania kopii zapasowej

Prośba dotycząca usługi FirestoreAdmin.CreateBackupSchedule.

Pola
parent

string

Wymagane. Nadrzędna baza danych.

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

BackupSchedule

Wymagane. Harmonogram tworzenia kopii zapasowych.

Tworzenie metadanych bazy danych

Ten typ nie zawiera pól.

Metadane związane z operacją tworzenia bazy danych.

CreateDatabaseRequest

Prośba dotycząca usługi FirestoreAdmin.CreateDatabase.

Pola
parent

string

Wymagane. Nazwa elementu nadrzędnego formularza projects/{project_id}
database

Database

Wymagane. Baza danych do utworzenia.
database_id

string

Wymagane. Identyfikator używany dla bazy danych, który stanie się ostatnim komponentem nazwy zasobu bazy danych.

Ta wartość powinna mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/, w tym pierwszy znak litera, a ostatnia litera lub cyfra. Nie może mieć postaci /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

„(domyślnie)” identyfikator bazy danych również jest prawidłowy.

Tworzenie żądania indeksu

Prośba dotycząca usługi FirestoreAdmin.CreateIndex.

Pola
parent

string

Wymagane. Nazwa elementu nadrzędnego formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

Wymagane. Indeks złożony do utworzenia.

Codzienne powtarzanie

Ten typ nie zawiera pól.

Reprezentuje cykliczny harmonogram uruchamiany codziennie.

Strefa czasowa jest ustawiona na UTC.

Baza danych

Baza danych Cloud Firestore.

Pola
name

string

Nazwa zasobu bazy danych. Format: projects/{project}/databases/{database}
uid

string

Tylko dane wyjściowe. Wygenerowany przez system identyfikator UUID4 tej bazy danych.
create_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ta baza danych została utworzona. Bazy danych utworzone przed 2016 rokiem nie wypełniają wartości create_time.
update_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ta baza danych została ostatnio zaktualizowana. Pamiętaj, że obejmuje to tylko aktualizacje zasobu bazy danych, a nie danych w niej zawartych.
delete_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa usunięcia tej bazy danych. Ustaw tylko wtedy, gdy baza danych została usunięta.
location_id

string

Lokalizacja bazy danych. Listę dostępnych lokalizacji znajdziesz na stronie https://cloud.google.com/firestore/docs/locations.
type

DatabaseType

Typ bazy danych. Informacje o tym, jak go wybrać, znajdziesz na stronie https://cloud.google.com/datastore/docs/firestore-or-datastore.
concurrency_mode

ConcurrencyMode

Tryb kontroli równoczesności, który ma być używany w tej bazie danych.
version_retention_period

Duration

Tylko dane wyjściowe. Okres, w którym wcześniejsze wersje danych są przechowywane w bazie danych.

Dowolny read lub query może w tym oknie określić read_time i odczytać stan bazy danych w tym momencie.

Jeśli funkcja odzyskiwania do określonego momentu jest włączona, okres przechowywania wynosi 7 dni. W przeciwnym razie okres przechowywania wynosi 1 godzinę.
earliest_version_time

Timestamp

Tylko dane wyjściowe. Najwcześniejsza sygnatura czasowa, w której można odczytać z bazy danych starsze wersje danych. Patrz [version_retention_period] powyżej; to pole zawiera wartość now - version_retention_period.

Ta wartość jest stale aktualizowana i w chwili wysyłania zapytania staje się nieaktualna. Jeśli używasz tej wartości do odzyskiwania danych, pamiętaj, aby uwzględnić czas od momentu wysłania zapytania o wartość do momentu rozpoczęcia przywracania.
point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

Określa, czy włączyć funkcję odzyskiwania danych w tej bazie danych.
app_engine_integration_mode

AppEngineIntegrationMode

Tryb integracji App Engine, który ma być używany w przypadku tej bazy danych.
key_prefix

string

Tylko dane wyjściowe. Prefiks klucza dla tej bazy danych. Ten prefiks key_prefix jest używany w połączeniu z identyfikatorem projektu („~”) do utworzenia identyfikatora aplikacji zwracanego przez interfejsy API Cloud Datastore w środowiskach wykonawczych pierwszej generacji Google App Engine.

Ta wartość może być pusta. W takim przypadku identyfikator aplikacji używany w przypadku kluczy zakodowanych w adresie URL to identyfikator projektu (np. foo zamiast v~foo).
delete_protection_state

DeleteProtectionState

Stan ochrony przed usunięciem w bazie danych.
cmek_config

CmekConfig

Opcjonalnie. Obecność wskazuje, że dla tej bazy danych włączony jest klucz CMEK.
previous_id

string

Tylko dane wyjściowe. Poprzedni identyfikator bazy danych zasobu bazy danych. To pole jest wypełniane tylko w przypadku usuniętych baz danych.
etag

string

Ta suma kontrolna jest obliczana przez serwer na podstawie wartości innych pól i może być wysyłana w przypadku żądań aktualizacji lub usunięcia, aby zapewnić klientowi aktualną wartość, zanim przejdziesz dalej.

Tryb integracji z mechanizmem App Engine

Typ trybu integracji App Engine.

Wartości w polu enum
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Nieużywane.
ENABLED Jeśli aplikacja App Engine znajduje się w tym samym regionie co ta baza danych, konfiguracja App Engine będzie miała wpływ na tę bazę danych. Obejmuje to wyłączenie aplikacji oraz i wyłączeniu zapisywania w tej bazie danych.
DISABLED

App Engine nie ma wpływu na możliwość obsługi żądań przez tę bazę danych.

Jest to domyślne ustawienie dla baz danych utworzonych przy użyciu interfejsu Firestore API.

Konfiguracja GCP

Konfiguracja klucza szyfrowania zarządzanego przez klienta (CMEK) dla bazy danych Firestore. Jeśli jej nie ma, baza danych jest zabezpieczona domyślnym kluczem szyfrowania Google.

Pola
kms_key_name

string

Wymagane. Do szyfrowania można używać tylko kluczy znajdujących się w tej samej lokalizacji co ta baza danych.

W przypadku „wielu regionów” nam5 Firestore odpowiada temu, że Cloud KMS ma wiele regionów. W przypadku wielu regionów eur3 Firestore odpowiada regionowi eur3 w Cloud KMS obejmujący wiele regionów. Więcej informacji znajdziesz na https://cloud.google.com/kms/docs/locations.

Oczekiwany format to projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
active_key_version[]

string

Tylko dane wyjściowe. Obecnie używane wersje klucza KMS. Podczas rotacji kluczy może być wiele używanych wersji klucza.

Oczekiwany format to projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

Tryb równoczesności

Typ trybu kontroli równoczesności transakcji.

Wartości w polu enum
CONCURRENCY_MODE_UNSPECIFIED Nieużywane.
OPTIMISTIC Używaj domyślnie optymistycznej kontroli równoczesności. Ten tryb jest dostępny w bazach danych Cloud Firestore.
PESSIMISTIC

Domyślnie używaj pesymistycznej kontroli równoczesności. Ten tryb jest dostępny w bazach danych Cloud Firestore.

Jest to domyślne ustawienie Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Domyślnie używaj optymistycznej kontroli równoczesności z grupami encji.

To jedyny tryb dostępny w Cloud Datastore.

Ten tryb jest też dostępny w Cloud Firestore w trybie Datastore, ale nie jest zalecany.

Typ bazy danych

Typ bazy danych. Informacje o tym, jak go wybrać, znajdziesz na stronie https://cloud.google.com/datastore/docs/firestore-or-datastore.

Zmiany trybu są dozwolone tylko wtedy, gdy baza danych jest pusta.

Wartości w polu enum
DATABASE_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość jest używana, jeśli typ bazy danych zostanie pominięty.
FIRESTORE_NATIVE Tryb natywny Firestore
DATASTORE_MODE Firestore w trybie Datastore.

Usuwanie stanu ochrony

Stan ochrony przed usunięciem bazy danych.

Wartości w polu enum
DELETE_PROTECTION_STATE_UNSPECIFIED Wartość domyślna. Nie określono typu ochrony przed usunięciem
DELETE_PROTECTION_DISABLED Ochrona przed usunięciem jest wyłączona
DELETE_PROTECTION_ENABLED Ochrona przed usunięciem jest włączona

aktywowanie odzyskiwania za pomocą PointInTimeRecovery

Włączenie funkcji odzyskiwania do określonego momentu.

Wartości w polu enum
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Nieużywane.
POINT_IN_TIME_RECOVERY_ENABLED

Odczyty są obsługiwane w przypadku wybranych wersji danych z ostatnich 7 dni:

  • Odczyt z dowolną sygnaturą czasową w ciągu ostatniej godziny
  • Odczytuje dane z 1-minutowych zrzutów powyżej 1 godziny i w ciągu 7 dni

Do określenia obsługiwanych wersji można użyć pakietów version_retention_period i earliest_version_time.
POINT_IN_TIME_RECOVERY_DISABLED Odczyty są obsługiwane w przypadku dowolnej wersji danych z ostatniej godziny.

Usunięcie żądania kopii zapasowej

Prośba dotycząca usługi FirestoreAdmin.DeleteBackup.

Pola
name

string

Wymagane. Nazwa kopii zapasowej do usunięcia.

format to projects/{project}/locations/{location}/backups/{backup}.

Usunięcie żądania planowania kopii zapasowej

żądanie [FirestoreAdmin.DeleteBackupSchedules][].

Pola
name

string

Wymagane. Nazwa harmonogramu tworzenia kopii zapasowych.

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

Usuwanie metadanych bazy danych

Ten typ nie zawiera pól.

Metadane związane z operacją usuwania bazy danych.

UsuńŻądanie bazy danych

Prośba dotycząca usługi FirestoreAdmin.DeleteDatabase.

Pola
name

string

Wymagane. Nazwa formularza projects/{project_id}/databases/{database_id}
etag

string

Bieżący tag bazy danych. Jeśli podany jest parametr eTag, który nie jest zgodny z bieżącym parametrem bazy danych, usunięcie zostanie zablokowane i zostanie zwrócony błąd FAILED_PREcondition.

DeleteIndexRequest

Prośba dotycząca usługi FirestoreAdmin.DeleteIndex.

Pola
name

string

Wymagane. Nazwa formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadane google.longrunning.Operation wyniku z FirestoreAdmin.ExportDocuments.

Pola
start_time

Timestamp

Czas rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja jest nadal wykonywana.
operation_state

OperationState

Stan operacji eksportu.
progress_documents

Progress

Postęp tej operacji w dokumentach.
progress_bytes

Progress

Postęp tej operacji w bajtach.
collection_ids[]

string

Które identyfikatory kolekcji są eksportowane.
output_uri_prefix

string

Miejsce, do którego są eksportowane dokumenty.
namespace_ids[]

string

Identyfikatory przestrzeni nazw, które są eksportowane.
snapshot_time

Timestamp

Sygnatura czasowa określająca wersję eksportowanej bazy danych. Jeśli nie określono inaczej, nie ma gwarancji spójności eksportowanych dokumentów.

Żądanie ExportDocumentsRequest

Prośba dotycząca usługi FirestoreAdmin.ExportDocuments.

Pola
name

string

Wymagane. Baza danych do wyeksportowania. Powinien mieć format: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Identyfikatory kolekcji do wyeksportowania. „Nieokreślony” oznacza wszystkie kolekcje.
output_uri_prefix

string

Identyfikator URI wyjściowy. Obecnie obsługuje tylko identyfikatory URI Google Cloud Storage w formacie: gs://BUCKET_NAME[/NAMESPACE_PATH], gdzie BUCKET_NAME to nazwa zasobnika Google Cloud Storage, a NAMESPACE_PATH to opcjonalna ścieżka przestrzeni nazw Google Cloud Storage. Wybierając nazwę, pamiętaj o przestrzeganiu wytycznych dotyczących nazewnictwa w Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Jeśli identyfikator URI jest zasobnikiem (bez ścieżki przestrzeni nazw), na podstawie czasu rozpoczęcia zostanie wygenerowany prefiks.
namespace_ids[]

string

Pusta lista reprezentuje wszystkie przestrzenie nazw. Jest to preferowane rozwiązanie w przypadku baz danych, które nie korzystają z przestrzeni nazw.

Pusty element ciągu reprezentuje domyślną przestrzeń nazw. Należy go używać, jeśli baza danych ma dane w innych przestrzeniach nazw, ale nie chcesz ich uwzględniać. Każda przestrzeń nazw na tej liście musi być unikalna.
snapshot_time

Timestamp

Sygnatura czasowa określająca wersję bazy danych do wyeksportowania. Sygnatura czasowa musi być w przeszłości, zaokrąglona do minuty i nie wcześniejsza niż earliestVersionTime. Jeśli określisz wartość, wyeksportowane dokumenty będą reprezentować spójny widok bazy danych we wskazanym czasie. W przeciwnym razie nie ma gwarancji spójności wyeksportowanych dokumentów.

Odpowiedź na eksport Dokumentów

Zwrócony w polu odpowiedzi google.longrunning.Operation.

Pola
output_uri_prefix

string

Lokalizacja plików wyjściowych. W ten sposób możesz rozpocząć importowanie do Cloud Firestore (w tym lub innym projekcie) po pomyślnym zakończeniu operacji.

Pole

Reprezentuje jedno pole w bazie danych.

Pola są pogrupowane według „grupy kolekcji”, która reprezentuje wszystkie kolekcje w bazie danych o tym samym identyfikatorze.

Pola
name

string

Wymagane. Nazwa pola w formacie projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Ścieżka pola może być prostą nazwą pola, np. address lub ścieżka do pól w obrębie wartości map_value , np. address.city lub specjalną ścieżkę pola. Jedyne prawidłowe pole specjalne to *, które reprezentuje dowolne pole.

Ścieżki pól można cytować za pomocą znaków (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),[,]oraz dowolnych znaków ASCII.

Przykłady: (uwaga: komentarze w tym miejscu są napisane w składni języka markdown, dlatego pojawia się dodatkowa warstwa znaków grawisowych reprezentujących blok kodu) \address.city`represents a field namedadres.miasto, not the map key miastoin the fieldadres. `*`represents a field named*`, a nie żadne pole.

Specjalny identyfikator Field zawiera domyślne ustawienia indeksowania wszystkich pól. Nazwa zasobu tego pola to: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Indeksy zdefiniowane w tym elemencie Field zostaną zastosowane do wszystkich pól, które nie mają własnej konfiguracji indeksów Field.
index_config

IndexConfig

Konfiguracja indeksu dla tego pola. Jeśli jej nie skonfigurujesz, indeksowanie pól zostanie przywrócone do konfiguracji zdefiniowanej przez zasadę ancestor_field. Aby bezpośrednio usunąć wszystkie indeksy dla tego pola, określ konfigurację indeksu z pustą listą indeksów.
ttl_config

TtlConfig

Konfiguracja TTL dla: Field. Włączenie lub wyłączenie tej opcji powoduje włączenie lub wyłączenie wartości TTL dla dokumentów, które mają Field.

Konfiguracja indeksu

Konfiguracja indeksu dla tego pola.

Pola
indexes[]

Index

Indeksy obsługiwane przez to pole.
uses_ancestor_config

bool

Tylko dane wyjściowe. Jeśli zasada ma wartość prawda, konfiguracja indeksu Field jest ustawiana na podstawie konfiguracji określonej w zasadzie ancestor_field. Jeśli ma wartość Fałsz, konfiguracja indeksu Field jest zdefiniowana.
ancestor_field

string

Tylko dane wyjściowe. Określa nazwę zasobu pola Field, na podstawie którego skonfigurowana jest konfiguracja indeksu tego pola (gdy uses_ancestor_config ma wartość prawda) lub wartości, od której wartość ta jest ustawiana, jeśli to pole nie ma konfiguracji indeksu (gdy uses_ancestor_config ma wartość fałsz).
reverting

bool

Tylko dane wyjściowe, jeśli ma wartość prawda, konfiguracja indeksu Field jest w trakcie przywracania. Po zakończeniu konfiguracja indeksu zmieni się na taki sam jak pole określone przez pole ancestor_field. W tym momencie uses_ancestor_config będzie mieć wartość true, a reverting – false.

Konfiguracja TTl

Konfiguracja TTL (czasu życia) dokumentów, dla których ustawiono ten Field.

Przechowywanie wartości sygnatury czasowej w polu z włączoną funkcją TTL będzie traktowane jako bezwzględny czas wygaśnięcia dokumentu. Wartości sygnatury czasowej z przeszłości wskazują, że dokument kwalifikuje się do natychmiastowego wygaśnięcia. Użycie innych typów danych lub pozostawienie tego pola spowoduje wyłączenie daty ważności poszczególnych dokumentów.

Pola
state

State

Tylko dane wyjściowe. Stan konfiguracji TTL.

Stan

Stan zastosowania konfiguracji TTL do wszystkich dokumentów.

Wartości w polu enum
STATE_UNSPECIFIED Stan jest nieokreślony lub nieznany.
CREATING Trwa stosowanie wartości TTL. Istnieje aktywna długo trwająca operacja w celu śledzenia zmiany. Nowo utworzone dokumenty będą miały określone wartości TTL zgodnie z żądaniem. Żądane wartości TTL istniejących dokumentów są nadal przetwarzane. Po przetworzeniu wartości TTL wszystkich istniejących dokumentów stan zmieni się na „AKTYWNE”.
ACTIVE Wartość TTL jest aktywna dla wszystkich dokumentów.
NEEDS_REPAIR Nie udało się włączyć konfiguracji TTL dla wszystkich istniejących dokumentów. Wartość TTL nowo utworzonych dokumentów będzie nadal stosowana. LRO zwrócona podczas ostatniej próby włączenia wartości TTL dla tego urządzenia Field nie udało się i może zawierać więcej szczegółów.

Metadane operacji

Metadane google.longrunning.Operation wyniku z FirestoreAdmin.UpdateField.

Pola
start_time

Timestamp

Czas rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja jest nadal wykonywana.
field

string

Zasób pola, na który działa ta operacja. Na przykład: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

Lista elementów IndexConfigDelta opisujących intencję tej operacji.
state

OperationState

Stan operacji.
progress_documents

Progress

Postęp tej operacji w dokumentach.
progress_bytes

Progress

Postęp tej operacji w bajtach.
ttl_config_delta

TtlConfigDelta

Opisuje delta konfiguracji TTL.

IndexConfigDelta

Informacje o zmianie konfiguracji indeksu.

Pola
change_type

ChangeType

Określa sposób zmiany indeksu.
index

Index

Zmieniany indeks.

Typ zmiany

Określa sposób zmiany indeksu.

Wartości w polu enum
CHANGE_TYPE_UNSPECIFIED Typ zmiany nie został określony lub nie jest znany.
ADD Dodaję indeks pojedynczego pola.
REMOVE Usuwam indeks pojedynczego pola.

TtlConfigDelta

Informacje o zmianie konfiguracji TTL.

Pola
change_type

ChangeType

Określa, jak zmienia się konfiguracja TTL.

Typ zmiany

Określa, jak zmienia się konfiguracja TTL.

Wartości w polu enum
CHANGE_TYPE_UNSPECIFIED Typ zmiany nie został określony lub nie jest znany.
ADD Dodaję konfigurację TTL.
REMOVE Usuwam konfigurację TTL.

Pobieranie żądania kopii zapasowej

Prośba dotycząca usługi FirestoreAdmin.GetBackup.

Pola
name

string

Wymagane. Nazwa kopii zapasowej do pobrania.

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

Żądanie zaplanowania kopii zapasowej

Prośba dotycząca usługi FirestoreAdmin.GetBackupSchedule.

Pola
name

string

Wymagane. Nazwa harmonogramu tworzenia kopii zapasowych.

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

Żądanie GetDatabaseRequest

Prośba dotycząca usługi FirestoreAdmin.GetDatabase.

Pola
name

string

Wymagane. Nazwa formularza projects/{project_id}/databases/{database_id}

GetFieldRequest

Prośba dotycząca usługi FirestoreAdmin.GetField.

Pola
name

string

Wymagane. Nazwa formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

Żądanie GetIndexRequest

Prośba dotycząca usługi FirestoreAdmin.GetIndex.

Pola
name

string

Wymagane. Nazwa formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Metadane importu dokumentów

Metadane google.longrunning.Operation wyniku z FirestoreAdmin.ImportDocuments.

Pola
start_time

Timestamp

Czas rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja jest nadal wykonywana.
operation_state

OperationState

Stan operacji importu.
progress_documents

Progress

Postęp tej operacji w dokumentach.
progress_bytes

Progress

Postęp tej operacji w bajtach.
collection_ids[]

string

Które identyfikatory kolekcji mają być importowane.
input_uri_prefix

string

Lokalizacja importowanych dokumentów.
namespace_ids[]

string

Identyfikatory przestrzeni nazw, które są importowane.

Żądanie ImportDocumentsRequest

Prośba dotycząca usługi FirestoreAdmin.ImportDocuments.

Pola
name

string

Wymagane. Baza danych, do której ma zostać zaimportowany. Powinien mieć format: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Identyfikatory kolekcji do zaimportowania. „Nie określono” oznacza, że wszystkie zbiory uwzględnione do importu.
input_uri_prefix

string

Lokalizacja wyeksportowanych plików. Ten atrybut musi być zgodny z wartością event_uri_prefix odpowiedzi ExportDocumentsResponse z zakończonego powodzeniem. Zobacz: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
namespace_ids[]

string

Pusta lista reprezentuje wszystkie przestrzenie nazw. Jest to preferowane rozwiązanie w przypadku baz danych, które nie korzystają z przestrzeni nazw.

Pusty element ciągu reprezentuje domyślną przestrzeń nazw. Należy go używać, jeśli baza danych ma dane w innych przestrzeniach nazw, ale nie chcesz ich uwzględniać. Każda przestrzeń nazw na tej liście musi być unikalna.

Indeks

Indeksy Cloud Firestore umożliwiają proste i złożone zapytania dotyczące dokumentów w bazie danych.

Pola
name

string

Tylko dane wyjściowe. Zdefiniowana przez serwer nazwa tego indeksu. W przypadku indeksów złożonych postać tej nazwy będzie miała postać: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} W przypadku indeksów z pojedynczym polem to pole będzie puste.
query_scope

QueryScope

Indeksy z określonym zakresem zapytań do kolekcji umożliwiają wykonywanie zapytań na zbiorze podrzędnym określonego dokumentu, określonym w czasie wykonywania zapytania i o tym samym identyfikatorze kolekcji.

Indeksy z określonym zakresem zapytań dotyczącym grupy kolekcji zezwalają na wykonywanie zapytań dotyczących wszystkich kolekcji pochodzących z określonego dokumentu, określonych w czasie wykonywania zapytania i mających ten sam identyfikator kolekcji co ten indeks.
api_scope

ApiScope

Zakres interfejsu API obsługiwany przez ten indeks.
fields[]

IndexField

Pola obsługiwane przez ten indeks.

W przypadku indeksów złożonych wymagana jest od 2 do 100 pól. Ostatni wpis w polu dotyczy zawsze ścieżki pola __name__. Jeśli podczas tworzenia pole __name__ nie zostało określone jako ostatnie pole, zostanie ono dodane automatycznie z tym samym kierunkiem co ostatnie zdefiniowane pole. Jeśli ostatnie pole w indeksie złożonym nie jest kierunkowe, pole __name__ zostanie uporządkowane ASCENDING (chyba że wyraźnie określono inaczej).

W przypadku indeksów z pojedynczym polem zawsze będzie to dokładnie 1 wpis ze ścieżką pola równą ścieżce powiązanego pola.
state

State

Tylko dane wyjściowe. Stan obsługi indeksu.

Interfejs API

Zakres interfejsu API definiuje interfejsy API (natywne (Firestore Native lub Firestore w trybie Datastore), które są obsługiwane w przypadku zapytań.

Wartości w polu enum
ANY_API Tego indeksu może używać tylko natywny interfejs API Firestore. Jest to ustawienie domyślne.
DATASTORE_MODE_API Indeksu może używać tylko interfejs Firestore w trybie zapytań API.

Pole indeksu

Pole w indeksie. Parametr pola_path określa, które pole jest indeksowane, a pole value_mode opisuje sposób indeksowania wartości pola.

Pola
field_path

string

Może być wartością name. W przypadku indeksów z pojedynczym polem wartość ta musi być zgodna z nazwą pola lub może zostać pominięty.
Pole sumy value_mode. Sposób indeksowania wartości pola. value_mode może mieć tylko jedną z tych wartości:
order

Order

Wskazuje, że to pole obsługuje porządkowanie według określonej kolejności lub porównywanie przy użyciu znaków =, !=, <, <=, >, >=.
array_config

ArrayConfig

Wskazuje, że to pole obsługuje operacje na array_value.
vector_config

VectorConfig

Wskazuje, że to pole obsługuje operacje dotyczące najbliższych sąsiadów i odległości na wektorze.

Konfiguracja tablicy

Obsługiwane konfiguracje wartości tablicy.

Wartości w polu enum
ARRAY_CONFIG_UNSPECIFIED Indeks nie obsługuje dodatkowych zapytań dotyczących tablic.
CONTAINS Indeks obsługuje zapytania obejmujące tablicę.

Zamówienie

Obsługiwane kolejności.

Wartości w polu enum
ORDER_UNSPECIFIED Kolejność nie jest określona. Nieprawidłowa opcja.
ASCENDING Pole jest uporządkowane według wartości pola rosnącego.
DESCENDING Pole jest uporządkowane według wartości pola malejącego.

Konfiguracja wektora

Konfiguracja indeksu do obsługi operacji wyszukiwania wektorowego

Pola
dimension

int32

Wymagane. Wymiar wektora, do którego ma zastosowanie ta konfiguracja.

Powstały indeks będzie zawierać tylko wektory tego wymiaru i można go użyć do wyszukiwania wektorowego z tym samym wymiarem.
Pole sumy type. Typ używanego indeksu. type może mieć tylko jedną z tych wartości:
flat

FlatIndex

Wskazuje, że indeks wektorów jest płaski.

Indeks płaski

Ten typ nie zawiera pól.

Indeks, który przechowuje wektory w płaskiej strukturze danych i obsługuje dokładne wyszukiwanie.

Zakres zapytania

Zakres zapytania definiuje zakres, w którym uruchamiane jest zapytanie. Określa się to w polu from StructuredQuery.

Wartości w polu enum
QUERY_SCOPE_UNSPECIFIED Zakres zapytania jest nieokreślony. Nieprawidłowa opcja.
COLLECTION Indeksy z określonym zakresem zapytań kolekcji umożliwiają wykonywanie zapytań na zbiorze podrzędnym określonego dokumentu, określonym w czasie wykonywania zapytania i o identyfikatorze kolekcji określonym przez indeks.
COLLECTION_GROUP Indeksy z określonym zakresem zapytań dotyczącym grupy kolekcji umożliwiają wykonywanie zapytań dotyczących wszystkich kolekcji, które mają identyfikator kolekcji określony przez indeks.
COLLECTION_RECURSIVE Uwzględnij w indeksie wszystkie elementy nadrzędne kolekcji. Dostępne tylko w przypadku baz danych w trybie Datastore.

Stan

Stan indeksu. Podczas tworzenia indeksu indeks będzie miał stan CREATING. Jeśli indeks zostanie utworzony, przejdzie do stanu READY. Jeśli podczas tworzenia indeksu wystąpi problem, zostanie on przeniesiony do stanu NEEDS_REPAIR.

Wartości w polu enum
STATE_UNSPECIFIED Stan nie jest określony.
CREATING Tworzę indeks. Istnieje aktywna długo trwająca operacja dla indeksu. Indeks jest aktualizowany podczas tworzenia dokumentu. Niektóre dane indeksu mogą istnieć.
READY Indeks jest gotowy do użycia. Indeks jest aktualizowany podczas tworzenia dokumentu. Indeks jest w pełni wypełniany ze wszystkich zapisanych dokumentów, których dotyczy.
NEEDS_REPAIR Trwa tworzenie indeksu, ale coś poszło nie tak. Nie ma żadnej aktywnej długo trwającej operacji dla indeksu, a ostatnia zakończona długo trwająca operacja zakończyła się niepowodzeniem. Indeks nie jest aktualizowany podczas tworzenia dokumentu. Niektóre dane indeksu mogą istnieć. Użyj interfejsu google.longrunning.Operations API, aby ustalić, dlaczego operacja, która ostatnio próbowała utworzyć ten indeks, nie powiodła się, a następnie ponownie utwórz indeks.

Metadane operacji indeksowania

Metadane google.longrunning.Operation wyniku z FirestoreAdmin.CreateIndex.

Pola
start_time

Timestamp

Czas rozpoczęcia tej operacji.
end_time

Timestamp

Czas zakończenia tej operacji. Ustawienie nie zostanie ustawione, jeśli operacja jest nadal wykonywana.
index

string

Zasób indeksu, na którym działa ta operacja. Na przykład: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

Stan operacji.
progress_documents

Progress

Postęp tej operacji w dokumentach.
progress_bytes

Progress

Postęp tej operacji w bajtach.

Wyświetlenie harmonogramu tworzenia kopii zapasowych

Prośba dotycząca usługi FirestoreAdmin.ListBackupSchedules.

Pola
parent

string

Wymagane. Nadrzędna baza danych.

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

Wyświetlenie listy harmonogramów kopii zapasowej

Odpowiedź dla: FirestoreAdmin.ListBackupSchedules.

Pola
backup_schedules[]

BackupSchedule

Lista wszystkich harmonogramów tworzenia kopii zapasowych.

Wyświetlanie listy kopii zapasowych

Prośba dotycząca usługi FirestoreAdmin.ListBackups.

Pola
parent

string

Wymagane. Lokalizacja, z której mają zostać utworzone kopie zapasowe.

Format to projects/{project}/locations/{location}. Użyj narzędzia {location} = '-', aby wyświetlić listę kopii zapasowych ze wszystkich lokalizacji w danym projekcie. Umożliwia to wyświetlanie listy kopii zapasowych z jednej lokalizacji lub ze wszystkich lokalizacji.

Wyświetlenie listy kopii zapasowych

Odpowiedź dla: FirestoreAdmin.ListBackups.

Pola
backups[]

Backup

Lista wszystkich kopii zapasowych projektu.
unreachable[]

string

Lista lokalizacji, z których nie udało się pobrać istniejących kopii zapasowych.

Zamiast odrzucania całych żądań, gdy dana lokalizacja jest nieosiągalna, ta odpowiedź zwraca częściowy zbiór wyników i listę lokalizacji, do których nie można uzyskać dostępu. Żądanie można ponowić w odniesieniu do pojedynczej lokalizacji, aby uzyskać konkretny błąd.

Żądanie wyświetlania baz danych

Żądanie wyświetlenia baz danych Firestore we wszystkich lokalizacjach projektu.

Pola
parent

string

Wymagane. Nazwa elementu nadrzędnego formularza projects/{project_id}
show_deleted

bool

Jeśli ma wartość prawda, zwraca też usunięte zasoby.

Odpowiedź ListDatabases

Lista baz danych projektu.

Pola
databases[]

Database

Bazy danych w projekcie.
unreachable[]

string

Jeśli nie będzie można wyświetlić danych dotyczących poszczególnych baz danych, zostaną one zarejestrowane tutaj.

Przykładowy wpis może wyglądać tak: projects/jakiś_projekt/locations/jakaś_lokalizacja Może się tak zdarzyć, jeśli region Cloud, w którym znajduje się baza danych, jest obecnie niedostępny. W tym przypadku nie możemy pobrać wszystkich informacji o bazie danych. Bardziej szczegółowy komunikat o błędzie (albo ewentualny pobranie zasobu) może być możliwy przez wysłanie polecenia „Get” żądanie zasobu lub listy dotyczące konkretnej lokalizacji.

Żądanie listy pól

Prośba dotycząca usługi FirestoreAdmin.ListFields.

Pola
parent

string

Wymagane. Nazwa elementu nadrzędnego formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Filtr, który ma być stosowany do listy wyników. Obecnie FirestoreAdmin.ListFields obsługuje tylko te pola, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj funkcję FirestoreAdmin.ListFields z filtrem zawierającym indexConfig.usesAncestorConfig:false lub ttlConfig:*.
page_size

int32

Liczba wyników do zwrócenia.
page_token

string

Token strony zwrócony z poprzedniego wywołania funkcji FirestoreAdmin.ListFields, który może zostać użyty do wyświetlenia następnej strony wyników.

Odpowiedź z polami listy

Odpowiedź dla: FirestoreAdmin.ListFields.

Pola
fields[]

Field

Wymagane pola.
next_page_token

string

Token strony, który może być używany do żądania innej strony wyników. Jeśli pole jest puste, oznacza to, że jest to ostatnia strona.

Żądanie ListyIndeksów

Prośba dotycząca usługi FirestoreAdmin.ListIndexes.

Pola
parent

string

Wymagane. Nazwa elementu nadrzędnego formularza projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Filtr, który ma być stosowany do listy wyników.
page_size

int32

Liczba wyników do zwrócenia.
page_token

string

Token strony zwrócony z poprzedniego wywołania funkcji FirestoreAdmin.ListIndexes, który może zostać użyty do wyświetlenia następnej strony wyników.

Odpowiedź Wyświetlanie indeksów

Odpowiedź dla: FirestoreAdmin.ListIndexes.

Pola
indexes[]

Index

Żądane indeksy.
next_page_token

string

Token strony, który może być używany do żądania innej strony wyników. Jeśli pole jest puste, oznacza to, że jest to ostatnia strona.

Metadane lokalizacji

Ten typ nie zawiera pól.

Wiadomość metadanych dla: google.cloud.location.Location.metadata.

Stan operacji

Opisuje stan operacji.

Wartości w polu enum
OPERATION_STATE_UNSPECIFIED Nie określono.
INITIALIZING Prośba jest przygotowywana do przetworzenia.
PROCESSING Żądanie jest obecnie przetwarzane.
CANCELLING Żądanie jest w trakcie anulowania po tym, jak użytkownik wywołał w tej operacji funkcję google.longrunning.Operations.CancelOperation.
FINALIZING Prośba została przetworzona i jest w fazie finalizacji.
SUCCESSFUL Żądanie zostało zrealizowane.
FAILED Żądanie zostało przetworzone, ale wystąpił błąd.
CANCELLED Żądanie zostało anulowane, gdy użytkownik wywołał funkcję google.longrunning.Operations.CancelOperation.

Postęp

Opisuje postęp operacji. Jednostka pracy jest ogólna i należy ją interpretować w zależności od tego, gdzie jest używany element Progress.

Pola
estimated_work

int64

Szacowany czas pracy.
completed_work

int64

Ilość wykonanych zadań.

Przywracanie metadanych bazy danych

Metadane instancji long-running operation z żądania [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

Pola
start_time

Timestamp

Czas rozpoczęcia przywracania.
end_time

Timestamp

Czas zakończenia przywracania bez ustawienia w przypadku trwającego przywracania.
operation_state

OperationState

Stan operacji przywracania.
database

string

Nazwa przywracanej bazy danych.
backup

string

Nazwa kopii zapasowej, z której przywracano dane.
progress_percentage

Progress

Odległość przywracania jest szacowana jako odsetek pozostałego czasu.

Żądanie przywracania bazy danych

Komunikat z prośbą o [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

Pola
parent

string

Wymagane. Projekt, w którym ma zostać przywrócona baza danych. Format to projects/{project_id}.
database_id

string

Wymagane. Identyfikator używany dla bazy danych, który stanie się ostatnim komponentem nazwy zasobu bazy danych. Ten identyfikator bazy danych nie może być powiązany z istniejącą bazą danych.

Ta wartość powinna mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/, w tym pierwszy znak litera, a ostatnia litera lub cyfra. Nie może mieć postaci /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

„(domyślnie)” identyfikator bazy danych również jest prawidłowy.

Pole sumy source.

source może mieć tylko jedną z tych wartości:
backup

string

Kopia zapasowa, z której chcesz przywrócić dane. Musi pochodzić z tego samego projektu co projekt nadrzędny.

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

Żądanie aktualizacji harmonogramu kopii zapasowej

Prośba dotycząca usługi FirestoreAdmin.UpdateBackupSchedule.

Pola
backup_schedule

BackupSchedule

Wymagane. Harmonogram tworzenia kopii zapasowych do zaktualizowania.
update_mask

FieldMask

Lista pól do zaktualizowania.

Aktualizowanie metadanych bazy danych

Ten typ nie zawiera pól.

Metadane związane z operacjami aktualizacji bazy danych.

Żądanie aktualizacji bazy danych

Prośba dotycząca usługi FirestoreAdmin.UpdateDatabase.

Pola
database

Database

Wymagane. Baza danych do aktualizacji.
update_mask

FieldMask

Lista pól do zaktualizowania.

UpdateFieldRequest

Prośba dotycząca usługi FirestoreAdmin.UpdateField.

Pola
field

Field

Wymagane. Pole do zaktualizowania.
update_mask

FieldMask

Maska względem pola. Jeśli określisz wartość, tylko konfiguracja określona przez tę maskę pola zostanie zaktualizowana w tym polu.

Powtarzanie co tydzień

Reprezentuje harmonogram cykliczny uruchamiany w określonym dniu tygodnia.

Strefa czasowa jest ustawiona na UTC.

Pola
day

DayOfWeek

Dzień tygodnia do uruchomienia.

DAY_OF_WEEK_UNSPECIFIED jest niedozwolony.