Zasób: pole
Reprezentuje pojedyncze pole w bazie danych.
Pola są pogrupowane według „Grupy kolekcji”, która reprezentuje wszystkie zbiory w bazie danych o tym samym identyfikatorze.
Zapis JSON |
---|
{ "name": string, "indexConfig": { object ( |
Pola | |
---|---|
name |
Wymagane. Nazwa pola formularza Ścieżka pola może być prostą nazwą pola, np. Ścieżki pól można podawać w cudzysłowach za pomocą znaków Przykłady: (uwaga: komentarze w tym miejscu są zapisywane w składni Markdown, dlatego istnieje dodatkowa warstwa lewików reprezentujących blok kodu) Specjalny |
indexConfig |
Konfiguracja indeksu dla tego pola. Jeśli zasada jest nieskonfigurowana, indeksowanie pól jest przywracane do konfiguracji określonej przez zasadę |
ttlConfig |
Konfiguracja TTL dla zasobnika |
IndexConfig
Konfiguracja indeksu dla tego pola.
Zapis JSON |
---|
{
"indexes": [
{
object ( |
Pola | |
---|---|
indexes[] |
Indeksy obsługiwane w przypadku tego pola. |
usesAncestorConfig |
Tylko dane wyjściowe. Jeśli ma wartość prawda, konfiguracja indeksu obiektu |
ancestorField |
Tylko dane wyjściowe. Określa nazwę zasobu |
reverting |
Tylko dane wyjściowe Jeśli ma wartość prawda, konfiguracja indeksu obiektu |
TtlConfig
Konfiguracja czasu życia danych (TTL) dla dokumentów, które mają ustawiony ten parametr Field
.
Zapisywanie wartości sygnatury czasowej w polu z włączoną wartością TTL będzie traktowane jako bezwzględny czas wygaśnięcia dokumentu. Wartości sygnatur czasowych z przeszłości wskazują, że dokument kwalifikuje się do natychmiastowego wygaśnięcia. Użycie innego typu danych lub pozostawienie tego pola spowoduje wyłączenie wygaśnięcia ważności pojedynczego dokumentu.
Zapis JSON |
---|
{
"state": enum ( |
Pola | |
---|---|
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 |
Stosuję wartość TTL. Istnieje aktywna długo trwająca operacja, aby śledzić zmianę. Do nowo zapisanych dokumentów zostaną zastosowane wartości TTL. Żą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 „AKTYWNY”. |
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. Do nowo zapisanych dokumentów nadal będą stosowane wartości TTL. Wartość LRO zwrócona podczas ostatniej próby włączenia wartości TTL dla tego urządzenia Field nie powiodła się. Możesz mieć więcej szczegółów. |
Metody |
|
---|---|
|
Pobiera metadane i konfigurację pola. |
|
Wyświetla konfigurację pola i metadane tej bazy danych. |
|
Aktualizuje konfigurację pola. |