Method: projects.databases.collectionGroups.fields.patch

Обновляет конфигурацию поля. В настоящее время обновления полей применяются только к конфигурации индекса с одним полем. Однако вызовы FirestoreAdmin.UpdateField должны предоставлять маску поля, чтобы избежать изменения любой конфигурации, о которой вызывающая сторона не знает. Маска поля должна быть указана как: { paths: "indexConfig" } .

Этот вызов возвращает google.longrunning.Operation , который можно использовать для отслеживания статуса обновления поля. Метаданные для операции будут иметь тип FieldOperationMetadata .

Чтобы настроить параметры поля по умолчанию для базы данных, используйте специальное Field с именем ресурса: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* .

HTTP-запрос

PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
field.name

string

Необходимый. Имя поля формы projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Путь к полю может представлять собой простое имя поля, например address , или путь к полям в MapValue, например, address.city , или специальный путь к полю. Единственным допустимым специальным полем является * , которое представляет любое поле.

Пути к полям могут быть заключены в кавычки (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), [ , ]`, а также любые символические символы ascii.

Примеры: (Примечание: комментарии здесь написаны с использованием синтаксиса уценки, поэтому существует дополнительный слой обратных кавычек для представления блока кода) \ address.city` represents a field named Address.city , not the map key in the field адрес . `*` represents a field named *`, а не любое поле.

Специальное Field содержит настройки индексации по умолчанию для всех полей. Имя ресурса этого поля: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Индексы, определенные в этом Field , будут применяться ко всем полям, которые не имеют собственной конфигурации индекса Field .

Параметры запроса

Параметры
updateMask

string ( FieldMask format)

Маска относительно поля. Если указано, в поле будет обновлена ​​только конфигурация, указанная этой маской поля.

Это разделенный запятыми список полных имен полей. Пример: "user.displayName,photo" .

Тело запроса

Тело запроса содержит экземпляр Field .

Тело ответа

В случае успеха тело ответа содержит экземпляр Operation .

Области авторизации

Требуется одна из следующих областей OAuth:

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

Для получения дополнительной информации см. Обзор аутентификации .