REST Resource: projects.databases.collectionGroups.fields

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 (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Pola
name

string

Wymagane. Nazwa pola formularza projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Ścieżka pola może być prostą nazwą pola, np. address, lub ścieżką do pól w obiekcie mapValue, 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/{projectId}/databases/{databaseId}/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

object (IndexConfig)

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

object (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.

IndexConfig

Konfiguracja indeksu dla tego pola.

Zapis JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Pola
indexes[]

object (Index)

Indeksy obsługiwane w przypadku tego pola.
usesAncestorConfig

boolean

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

string

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

boolean

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 ancestorField. Gdy to nastąpi, usesAncestorConfig będzie mieć wartość true, a reverting zmieni wartość na false.

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 (State)
}
Pola
state

enum (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

get

 Pobiera metadane i konfigurację pola.

list

 Wyświetla konfigurację pola i metadane tej bazy danych.

patch

 Aktualizuje konfigurację pola.