Aktualizuje konfigurację pola. Obecnie aktualizacje pól dotyczą tylko konfiguracji indeksu pojedynczego pola. Wywołania FirestoreAdmin.UpdateField
powinny jednak dostarczać maskę pola, aby uniknąć zmiany konfiguracji, o której element wywołujący nie wie. Maską pola należy określić jako: { paths: "indexConfig" }
.
To wywołanie zwraca wartość google.longrunning.Operation
, która może służyć do śledzenia stanu aktualizacji pola. Metadane operacji będą typu FieldOperationMetadata
.
Aby skonfigurować domyślne ustawienia pola bazy danych, użyj specjalnego pola Field
o nazwie zasobu: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
Żądanie HTTP
PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
field.name |
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 |
Parametry zapytania
Parametry | |
---|---|
updateMask |
Maska powiązana z polem. Jeśli określisz konfigurację, w polu zostanie zaktualizowana tylko konfiguracja określona przez tę maskę pola. Jest to rozdzielona przecinkami lista pełnych i jednoznacznych nazw pól. Przykład: |
Treść żądania
Treść żądania zawiera wystąpienie elementu Field
.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation
.
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.