Package google.firestore.admin.v1

string

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

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

string

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

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

string

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

Timestamp

Tylko dane wyjściowe. Kopia zapasowa zawiera obecnie spójną zewnętrznie kopię bazy danych.

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa wygaśnięcia kopii zapasowej.

State

Tylko dane wyjściowe. Obecny stan kopii zapasowej.

string

Tylko dane wyjściowe. Unikalny identyfikator harmonogramu tworzenia kopii zapasowych we wszystkich lokalizacjach i bazach danych danego projektu.

Zostanie ono przypisane automatycznie.

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

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa utworzenia tego harmonogramu tworzenia kopii zapasowych i od tego momentu obowiązuje.

Przed tą datą nie będą tworzone żadne kopie zapasowe dla tego harmonogramu.

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji tego harmonogramu tworzenia kopii zapasowych. Gdy harmonogram tworzenia kopii zapasowych zostanie utworzony po raz pierwszy, wartość ta jest taka sama jak wartość create_time.

Duration

W porównaniu do czasu utworzenia kopii zapasowej należy usunąć ją (np. zachować kopie zapasowe przez 7 dni).

DailyRecurrence

W przypadku harmonogramu uruchamianego codziennie.

WeeklyRecurrence

Dla harmonogramu uruchamianego co tydzień w określonym dniu.

string

Wymagane. Nadrzędna baza danych.

Formatuj: projects/{project}/databases/{database}

BackupSchedule

Wymagane. Harmonogram tworzenia kopii zapasowych.

string

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

Database

Wymagane. Baza danych do utworzenia.

string

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

Powinna ona mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/ , gdzie pierwszy znak to litera, a ostatnia litera lub cyfra. Nie może być jak identyfikator UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

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

string

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

Index

Wymagane. Indeks złożony do utworzenia.

string

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

string

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

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa utworzenia tej bazy danych. Bazy danych utworzone przed 2016 r. nie są wypełniane pola create_time.

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji tej bazy danych. Pamiętaj, że obejmuje to tylko aktualizacje zasobu bazy danych, a nie zawarte w niej dane.

string

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

DatabaseType

Typ bazy danych. Informacje o wyborze znajdziesz na stronie https://cloud.google.com/datastore/docs/firestore-or-datastore.

ConcurrencyMode

Tryb kontroli równoczesności używany w tej bazie danych.

Duration

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

Każdy element read lub query może określać wartość read_time w tym oknie i odczytywać w tym czasie stan bazy danych.

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

Timestamp

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

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

PointInTimeRecoveryEnablement

Określa, czy włączyć funkcję odzyskiwania do określonego momentu w tej bazie danych.

AppEngineIntegrationMode

Tryb integracji App Engine używany na potrzeby tej bazy danych.

string

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

Ta wartość może być pusta. W takim przypadku identyfikator appid, którego chcesz użyć w przypadku kluczy zakodowanych na potrzeby adresu URL, to project_id (np. foo zamiast v~foo).

DeleteProtectionState

Stan ochrony przed usunięciem bazy danych.

CmekConfig

Opcjonalnie. Obecność oznacza, że klucz CMEK jest włączony w tej bazie danych.

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 i usunięcia w celu sprawdzenia, czy klient ma aktualną wartość, zanim przejdziesz dalej.

string

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

W przypadku bazy danych nam5 w Firestore odpowiada to działaniu Cloud KMS w wielu regionach. W przypadku wielu regionów eur3 w Firestore odpowiada to Europie z wieloma regionami Cloud KMS. 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}.

string

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

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

string

Wymagane. Nazwa kopii zapasowej do usunięcia.

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

string

Wymagane. Nazwa harmonogramu tworzenia kopii zapasowych.

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

string

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

string

Bieżący tag bazy danych. Jeśli zostanie podany tag etag, który nie jest zgodny z bieżącym tagiem bazy danych, usunięcie zostanie zablokowane i wyświetli się błąd FAILED_PRECondition.

string

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

Timestamp

Godzina rozpoczęcia tej operacji.

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.

OperationState

Stan operacji eksportowania.

Progress

Postęp tej operacji w dokumentach.

Progress

Postęp tej operacji (w bajtach).

string

Identyfikatory kolekcji, które są eksportowane.

string

miejsce eksportowania dokumentów;

string

Które identyfikatory przestrzeni nazw są eksportowane.

Timestamp

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

string

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

string

Identyfikatory kolekcji do wyeksportowania. Nieokreślone oznacza wszystkie kolekcje.

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 wytycznych dotyczących nazw w Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Jeśli identyfikator URI jest zasobnikiem (bez ścieżki przestrzeni nazw), prefiks zostanie wygenerowany na podstawie czasu rozpoczęcia.

string

Pusta lista zawiera wszystkie przestrzenie nazw. Jest to preferowane użycie w przypadku baz danych, które nie korzystają z przestrzeni nazw.

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

Timestamp

Sygnatura czasowa odpowiadająca wersji bazy danych do wyeksportowania. Sygnatura czasowa musi być datą przeszłą i zaokrąglona do minuty. Nie może być starsza niż earliestVersionTime. Jeśli określisz to ustawienie, wyeksportowane dokumenty będą reprezentować spójny widok bazy danych w podanym czasie. W przeciwnym razie nie ma gwarancji spójności wyeksportowanych dokumentów.

string

Lokalizacja plików wyjściowych. Możesz użyć tych informacji, aby rozpocząć import do Cloud Firestore (tego lub innego projektu) po pomyślnym zakończeniu operacji.

string

Wymagane. Nazwa pola formularza 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żką do pól w obrębie wartości mapy, np. address.city, lub specjalną ścieżką pola. Jedynym prawidłowym polem specjalnym jest *, które reprezentuje dowolne pole.

Ścieżki pól można podawać w cudzysłowach 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 symboli ASCII.

Przykłady: (uwaga: komentarze w tym miejscu są zapisywane w składni Markdown, dlatego istnieje dodatkowa warstwa lewików reprezentujących blok kodu) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, a nie żadne pole.

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

IndexConfig

Konfiguracja indeksu dla tego pola. Jeśli zasada jest nieskonfigurowana, indeksowanie pól jest przywracane do konfiguracji określonej przez zasadę ancestor_field. Aby wyraźnie usunąć wszystkie indeksy dla tego pola, określ konfigurację indeksu z pustą listą indeksów.

TtlConfig

Konfiguracja TTL dla zasobnika Field. Ustawienie lub skasowanie tej opcji spowoduje włączenie lub wyłączenie czasu TTL dla dokumentów zawierających ten element Field.

Index

Indeksy obsługiwane w przypadku tego pola.

bool

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

string

Tylko dane wyjściowe. Określa nazwę zasobu Field, z którego skonfigurowano indeks tego pola (gdy uses_ancestor_config ma wartość prawda) lub z której wartość zostałaby ustawiona, jeśli to pole nie miało konfiguracji indeksu (gdy uses_ancestor_config ma wartość fałsz).

bool

Tylko dane wyjściowe Jeśli ma wartość prawda, konfiguracja indeksu obiektu Field jest w trakcie cofania. Po zakończeniu konfiguracja indeksu przejdzie do tego samego stanu co pole określone w polu ancestor_field. Gdy to nastąpi, uses_ancestor_config będzie mieć wartość true, a reverting zmieni wartość na false.

State

Tylko dane wyjściowe. Stan konfiguracji TTL.

Timestamp

Godzina rozpoczęcia tej operacji.

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.

string

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

IndexConfigDelta

Lista elementów IndexConfigDelta, która opisuje cel tej operacji.

OperationState

Stan operacji.

Progress

Postęp tej operacji w dokumentach.

Progress

Postęp tej operacji (w bajtach).

TtlConfigDelta

Opisuje delta konfiguracji TTL.

ChangeType

Określa, jak zmienia się indeks.

Index

Zmieniany indeks.

ChangeType

Określa, jak zmienia się konfiguracja TTL.

string

Wymagane. Nazwa kopii zapasowej do pobrania.

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

string

Wymagane. Nazwa harmonogramu tworzenia kopii zapasowych.

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

string

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

string

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

string

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

Timestamp

Godzina rozpoczęcia tej operacji.

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.

OperationState

Stan operacji importu.

Progress

Postęp tej operacji w dokumentach.

Progress

Postęp tej operacji (w bajtach).

string

Identyfikatory kolekcji, które są importowane.

string

Lokalizacja importowanych dokumentów.

string

Identyfikatory przestrzeni nazw, które są importowane.

string

Wymagane. Baza danych, do której ma nastąpić import. Powinien mieć taki format: projects/{project_id}/databases/{database_id}.

string

Identyfikatory kolekcji do zaimportowania. Nieokreślone oznacza, że import obejmuje wszystkie kolekcje.

string

Lokalizacja wyeksportowanych plików. Musi on być zgodny z parametrem „output_uri_prefix” atrybutu ExportDocumentsResponse z eksportu, który został ukończony. Zobacz: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

string

Pusta lista zawiera wszystkie przestrzenie nazw. Jest to preferowane użycie w przypadku baz danych, które nie korzystają z przestrzeni nazw.

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

string

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

QueryScope

Indeksy o określonym zakresie zapytania kolekcji umożliwiają wysyłanie zapytań do kolekcji, która jest podrzędna względem określonego dokumentu, określona w czasie wykonywania zapytania i o tym samym identyfikatorze kolekcji.

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

ApiScope

Zakres interfejsu API obsługiwany przez ten indeks.

IndexField

Pola obsługiwane przez ten indeks.

W przypadku indeksów złożonych wymaga to od 2 do 100 pól. Ostatni wpis w polu zawsze dotyczy ścieżki pola __name__. Jeśli podczas tworzenia pola __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 indeksu złożonego nie jest kierunkowe, pole __name__ ma kolejność ASCENDING (chyba że wyraźnie określono inaczej).

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

State

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

string

Może to być nazwa. W przypadku indeksów pojedynczych pól wartość musi być zgodna z nazwą pola lub może zostać pominięte.

Order

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

ArrayConfig

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

VectorConfig

Wskazuje, że to pole obsługuje operacje dotyczące najbliższego sąsiada i operacje odległości na wektorze.

int32

Wymagane. Wymiar wektorowy, którego dotyczy ta konfiguracja.

Powstały indeks będzie zawierał tylko wektory tego wymiaru i można go używać do wyszukiwania wektorowego z tym samym wymiarem.

FlatIndex

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

Timestamp

Godzina rozpoczęcia tej operacji.

Timestamp

Czas zakończenia tej operacji. Wartość ta zostanie nieskonfigurowana, jeśli operacja jest w toku.

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}

OperationState

Stan operacji.

Progress

Postęp tej operacji w dokumentach.

Progress

Postęp tej operacji (w bajtach).

string

Wymagane. Nadrzędna baza danych.

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

BackupSchedule

Lista wszystkich harmonogramów tworzenia kopii zapasowych.

string

Wymagane. Lokalizacja, z której wyświetlane są kopie zapasowe.

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

Backup

Lista wszystkich kopii zapasowych projektu.

string

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

Zamiast blokować całe żądania, gdy dana lokalizacja jest nieosiągalna, ta odpowiedź zwraca częściowy zbiór wyników i listę lokalizacji, do których nie można dotrzeć. Można ponowić żądanie dla pojedynczej lokalizacji, aby uzyskać konkretny błąd.

string

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

Database

Bazy danych w projekcie.

string

Jeśli nie można wyświetlić danych o poszczególnych bazach danych, zostaną one zapisane tutaj.

Przykładowy wpis może wyglądać tak: projects/jakiś_projekt/lokalizacje/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 szczegółów dotyczących bazy danych. Aby uzyskać bardziej szczegółowy komunikat o błędzie (lub pobrać zasób), możesz wysłać żądanie „Get” dla zasobu lub „List” dla konkretnej lokalizacji.

string

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

string

Filtr, który zostanie zastosowany do wyników z listy. Obecnie FirestoreAdmin.ListFields obsługuje tylko pola listy, które zostały jawnie zastąpione. Aby wysłać to zapytanie, wywołaj to zapytanie FirestoreAdmin.ListFields za pomocą filtra zawierającego indexConfig.usesAncestorConfig:false .

int32

Liczba wyników do zwrócenia.

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.

Field

Wymagane pola.

string

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

string

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

string

Filtr, który zostanie zastosowany do wyników z listy.

int32

Liczba wyników do zwrócenia.

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.

Index

Żądane indeksy.

string

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

int64

Szacunkowy nakład pracy.

int64

Ilość wykonanych zadań.

Timestamp

Godzina rozpoczęcia przywracania.

Timestamp

Czas zakończenia przywracania, nieokreślony w przypadku trwających przywracania.

OperationState

Stan operacji przywracania.

string

Nazwa bazy danych, do której przywracasz dane.

string

Nazwa kopii zapasowej, z której jest przywracana.

Progress

Długość czasu przywracania to szacowany odsetek pozostałego czasu.

string

Wymagane. Projekt, w którym chcesz przywrócić bazę danych. Format: projects/{project_id}.

string

Wymagane. Identyfikator używany przez bazę 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.

Powinna ona mieć od 4 do 63 znaków. Prawidłowe znaki to /[a-z][0-9]-/ , gdzie pierwszy znak to litera, a ostatnia litera lub cyfra. Nie może być jak identyfikator UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

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

string

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

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

BackupSchedule

Wymagane. Harmonogram tworzenia kopii zapasowych do zaktualizowania.

FieldMask

Lista pól do zaktualizowania.

Database

Wymagane. Baza danych do zaktualizowania.

FieldMask

Lista pól do zaktualizowania.

Field

Wymagane. Pole do zaktualizowania.

FieldMask

Maska powiązana z polem. Jeśli określisz konfigurację, w polu zostanie zaktualizowana tylko konfiguracja określona przez tę maskę pola.

DayOfWeek

Dzień tygodnia.

Dzień DAY_OF_WEEK_UNSPECIFIED jest niedozwolony.