Package google.firestore.admin.v1beta1

Indeks

FirestoreAdmin

Cloud Firestore Admin API.

Ten interfejs API zapewnia kilka usług administracyjnych dla Cloud Firestore.

Pojęcia

Projekty, baza danych, przestrzeń nazw, kolekcja i dokument są używane zgodnie z definicją w interfejsie Google Cloud Firestore API.

Operacja: operacja oznacza działanie wykonywane w tle.

Usługi

Indeks

Usługa indeksu zarządza indeksami Cloud Firestore.

Indeks jest tworzony asynchronicznie. Dla każdej takiej operacji asynchronicznej tworzony jest zasób operacji. Zapytanie o stan operacji (w tym wszelkie napotkane błędy) można przesłać za pomocą zasobu operacji.

Metadane

Zapewnia metadane i informacje statystyczne dotyczące danych w Cloud Firestore. Dane dostarczane w ramach tego interfejsu API mogą być nieaktualne.

Operacja

Kolekcja Operacje zawiera rejestr działań wykonanych dla określonego projektu (w tym wszelkich operacji w toku). Operacje nie są tworzone bezpośrednio, ale przez wywołania innych zbiorów lub zasobów.

Operacja, która nie została jeszcze zakończona, może zostać anulowana. Żądanie anulowania jest asynchroniczne i operacja może być kontynuowana przez pewien czas po wysłaniu żądania anulowania.

Wykonana operacja może zostać usunięta, aby nie pojawiała się już w kolekcji operacji.

Operacje są tworzone przez usługę FirestoreAdmin, ale są dostępne przez usługę google.longrunning.Operations.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Tworzy określony indeks. Początkowy stan nowo utworzonego indeksu to CREATING. Po zwróceniu wartości google.longrunning.Operation stan zmieni się na READY. Jeśli indeks już istnieje, wywołanie zwróci stan ALREADY_EXISTS.

Podczas tworzenia może wystąpić błąd. W takim przypadku indeks zostanie przeniesiony do stanu ERROR. Proces można przywrócić, naprawiając dane, które spowodowały błąd, usuwając indeks za pomocą parametru delete, a następnie ponownie tworząc indeks za pomocą parametru create.

Nie można tworzyć indeksów z pojedynczym polem.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Usuwa indeks.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Eksportuje kopię wszystkich dokumentów lub ich podzbioru z Google Cloud Firestore do innego systemu pamięci masowej, na przykład Google Cloud Storage. Ostatnie aktualizacje dokumentów 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 eksportowania zostanie anulowana przed zakończeniem, może ona pozostawić w Google Cloud Storage częściowe dane.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Pobiera indeks.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
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żna monitorować i zarządzać nim za pomocą tworzonego zasobu operacji. Jeśli operacja importowania dokumentów zostanie anulowana, możliwe, że podzbiór danych został już zaimportowany do Cloud Firestore.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Wyświetla listę indeksów, które pasują do określonych filtrów.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.

CreateIndexRequest

Prośba dotycząca: FirestoreAdmin.CreateIndex.

Pola
parent

string

Nazwa bazy danych, do której będzie miał zastosowanie ten indeks. Na przykład: projects/{project_id}/databases/{database_id}
index

Index

Indeks do utworzenia. Pola nazwy i stanu mają charakter informacyjny i będą ignorowane. Niektórych indeksów pojedynczych pól nie można utworzyć ani usunąć.

DeleteIndexRequest

Prośba dotycząca: FirestoreAdmin.DeleteIndex.

Pola
name

string

Nazwa indeksu. Na przykład: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadane operacji ExportDocuments.

Pola
start_time

Timestamp

Godzina rozpoczęcia pracy nad operacji.
end_time

Timestamp

Czas zakończenia operacji. Anuluj ustawienie, jeśli operacja jest nadal aktywna.
operation_state

OperationState

Stan operacji eksportowania.
progress_documents

Progress

Szacowana liczba przetworzonych dokumentów.
progress_bytes

Progress

Szacunkowa liczba przetworzonych bajtów.
collection_ids[]

string

Identyfikatory kolekcji, które są eksportowane.
output_uri_prefix

string

Miejsce, do którego są eksportowane elementy.

ExportDocumentsRequest

Prośba dotycząca: FirestoreAdmin.ExportDocuments.

Pola
name

string

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

string

Identyfikatory kolekcji do wyeksportowania. Nieokreślone 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 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.

ExportDocumentsResponse

Zwracana w polu odpowiedzi google.longrunning.Operation.

Pola
output_uri_prefix

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.

GetIndexRequest

Prośba dotycząca: FirestoreAdmin.GetIndex.

Pola
name

string

Nazwa indeksu. Na przykład: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

Metadane operacji importowania dokumentów.

Pola
start_time

Timestamp

Godzina rozpoczęcia pracy nad operacji.
end_time

Timestamp

Czas zakończenia operacji. Anuluj ustawienie, jeśli operacja jest nadal aktywna.
operation_state

OperationState

Stan operacji importu.
progress_documents

Progress

Szacowana liczba przetworzonych dokumentów.
progress_bytes

Progress

Szacunkowa liczba przetworzonych bajtów.
collection_ids[]

string

Identyfikatory kolekcji, które są importowane.
input_uri_prefix

string

Lokalizacja importowanych dokumentów.

ImportDocumentsRequest

Prośba dotycząca: FirestoreAdmin.ImportDocuments.

Pola
name

string

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

string

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

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

Indeks

Definicja indeksu.

Pola
name

string

Nazwa zasobu indeksu. Tylko dane wyjściowe.
collection_id

string

Identyfikator kolekcji, do której ma zastosowanie ten indeks. Wymagane.
fields[]

IndexField

Pola do indeksowania.
state

State

Stan indeksu. Tylko dane wyjściowe.

Stan

Stan indeksu. Podczas tworzenia indeksu będzie on miał stan CREATING. Jeśli indeks zostanie utworzony, przejdzie do stanu READY. Jeśli nie można utworzyć indeksu, przejdzie on do stanu ERROR.

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 pisania dokumentu. Mogą istnieć dane indeksu.
READY Indeks jest gotowy do użycia. Indeks jest aktualizowany podczas pisania dokumentu. Indeks jest w pełni wypełniany ze wszystkich przechowywanych dokumentów, do których ma zastosowanie.
ERROR Tworzę indeks, ale coś poszło nie tak. Nie ma żadnej aktywnej długo trwającej operacji, a ostatnia zakończona długotrwała operacja zakończyła się niepowodzeniem. Indeks nie jest aktualizowany podczas pisania dokumentu. Mogą istnieć dane indeksu.

IndexField

Pole indeksu.

Pola
field_path

string

Ścieżka pola. Musi być zgodny ze specyfikacją ścieżki pola opisaną w [google.firestore.v1beta1.Document.fields][fields]. Specjalnej ścieżki pola __name__ można użyć samodzielnie lub na końcu ścieżki. Typu __type__ można użyć tylko na końcu ścieżki.
mode

Mode

Tryb pola.

Tryb

Tryb określa sposób indeksowania pola.

Wartości w polu enum
MODE_UNSPECIFIED Nie określono trybu.
ASCENDING Wartości pola są indeksowane w taki sposób, aby można było obsługiwać sekwencjonowanie w kolejności rosnącej, a także zapytania za pomocą znaków <, >, <=, >= oraz =.
DESCENDING Wartości pola są indeksowane w taki sposób, aby można było obsługiwać sekwencjonowanie w kolejności malejącej, a także zapytania za pomocą znaków <, >, <=, >= oraz =.
ARRAY_CONTAINS Wartości w tablicy pola są indeksowane w sposób umożliwiający obsługę członkostwa za pomocą zapytań ARRAY_CONTAINS.

IndexOperationMetadata

Metadane na potrzeby operacji indeksowania. Te metadane wypełniają pole metadanych google.longrunning.Operation.

Pola
start_time

Timestamp

Godzina rozpoczęcia pracy nad operacji.
end_time

Timestamp

Czas zakończenia operacji. Anuluj ustawienie, jeśli operacja jest nadal aktywna.
index

string

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

OperationType

Typ operacji indeksowania.
cancelled

bool

Prawda, jeśli google.longrunning.Operation została anulowana. Jeśli trwa anulowanie, wartość anulowania będzie miała wartość prawda, ale zasada google.longrunning.Operation.done będzie mieć wartość fałsz.
document_progress

Progress

Postęp bieżącej operacji mierzony w liczbie dokumentów.

OperationType

Typ operacji indeksowania.

Wartości w polu enum
OPERATION_TYPE_UNSPECIFIED Nie określono. Nigdy nie ustawiane przez serwer.
CREATING_INDEX Operacja tworzy indeks. Zainicjowane przez połączenie CreateIndex.

ListIndexesRequest

Prośba dotycząca: FirestoreAdmin.ListIndexes.

Pola
parent

string

Nazwa bazy danych. Na przykład: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

Standardowy rozmiar strony listy.
page_token

string

Standardowy token strony listy.

ListIndexesResponse

Odpowiedź dotycząca: FirestoreAdmin.ListIndexes.

Pola
indexes[]

Index

Indeksy.
next_page_token

string

Standardowy token listy następnej strony.

LocationMetadata

Ten typ nie ma żadnych pól.

Wiadomość z metadanymi dla google.cloud.location.Location.metadata.

OperationState

Różne możliwe stany trwającej operacji.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono.
INITIALIZING Żądanie jest przygotowywane do przetworzenia.
PROCESSING Żądanie jest obecnie przetwarzane.
CANCELLING Żądanie jest w trakcie anulowania po tym, jak użytkownik wywołał tę operację google.longrunning.Operations.CancelOperation.
FINALIZING Prośba została przetworzona i jest w trakcie finalizacji.
SUCCESSFUL Żądanie zostało przetworzone pomyślnie.
FAILED Żądanie zostało zakończone, ale wystąpił błąd.
CANCELLED Żądanie zostało zakończone po tym, jak użytkownik wywołał google.longrunning.Operations.CancelOperation.

Postęp

Mierzy postęp określonego wskaźnika.

Pola
work_completed

int64

szacowaną ilość wykonanych zadań; Pamiętaj, że ta wartość może być większa niż work_estimated.
work_estimated

int64

Szacowana ilość pracy do wykonania. Zero, jeśli szacowany czas pracy jest niedostępny. Może się zmienić w miarę postępów pracy.