REST Resource: projects.databases.collectionGroups.fields

Ресурс: Поле

Представляет одно поле в базе данных.

Поля сгруппированы по «Группе коллекций», которая представляет все коллекции в базе данных с одинаковым идентификатором.

JSON-представление 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Поля
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 .

indexConfig

object ( IndexConfig )

Конфигурация индекса для этого поля. Если значение не установлено, индексация полей вернется к конфигурации, определенной ancestorField . Чтобы явно удалить все индексы для этого поля, укажите конфигурацию индекса с пустым списком индексов.

ttlConfig

object ( TtlConfig )

Конфигурация TTL для этого Field . Установка или снятие этой настройки включит или отключит TTL для документов, имеющих это Field .

ИндексКонфиг

Конфигурация индекса для этого поля.

JSON-представление 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Поля
indexes[]

object ( Index )

Индексы, поддерживаемые для этого поля.

usesAncestorConfig

boolean

Только вывод. Если установлено значение true, конфигурация индекса Field задается на основе конфигурации, указанной в ancestorField . Если значение равно false, конфигурация индекса Field определяется явно.

ancestorField

string

Только вывод. Указывает имя ресурса Field , из которого задается конфигурация индекса этого поля (если usesAncestorConfig равно true) или из которого оно было бы установлено, если бы это поле не имело конфигурации индекса (когда usesAncestorConfig равно false).

reverting

boolean

Только вывод. Если установлено значение true, конфигурация индекса Field находится в процессе восстановления. После завершения конфигурация индекса перейдет в то же состояние, что и поле, указанное в ancestorField , после чего usesAncestorConfig будет true , а reverting — false .

Ттлконфиг

Конфигурация TTL (срока жизни) для документов, у которых установлено это Field .

Сохранение значения временной метки в поле с поддержкой TTL будет рассматриваться как абсолютное время истечения срока действия документа. Значения временных меток в прошлом указывают на то, что срок действия документа истекает немедленно. Использование любого другого типа данных или отсутствие поля отключит срок действия отдельного документа.

JSON-представление 
{
  "state": enum (State)
}
Поля
state

enum ( State )

Только вывод. Состояние конфигурации TTL.

Состояние

Состояние применения конфигурации TTL ко всем документам.

Перечисления
STATE_UNSPECIFIED Состояние не указано или неизвестно.
CREATING TTL применяется. Существует активная длительная операция по отслеживанию изменений. Вновь написанные документы будут иметь TTL по запросу. Запрошенные TTL для существующих документов все еще обрабатываются. Когда TTL всех существующих документов будут обработаны, состояние перейдет в «АКТИВНО».
ACTIVE TTL активен для всех документов.
NEEDS_REPAIR Конфигурацию TTL невозможно включить для всех существующих документов. Для вновь написанных документов по-прежнему будет применяться срок жизни. LRO вернулся, когда последняя попытка включить TTL для этого Field не удалась, и может содержать более подробную информацию.

Методы

get

 Получает метаданные и конфигурацию поля.

list

 Перечисляет конфигурацию полей и метаданные для этой базы данных.

patch

 Обновляет конфигурацию поля.