REST Resource: projects.databases.collectionGroups.fields

Ressource: Field

Représente un champ unique de la base de données.

Les champs sont regroupés en fonction de leur "groupe de collections", qui représente toutes les collections de la base de données ayant le même identifiant.

Représentation JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Champs
name

string

Obligatoire. Un nom de champ au format projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Un chemin d'accès de champ peut être un simple nom de champ, par exemple address , ou un chemin d'accès à des champs dans mapValue (par exemple, address.city) ou un chemin d'accès de champ spécial. Le seul champ spécial valide est *, qui représente n'importe quel champ.

Les chemins d'accès des champs peuvent être indiqués à l'aide de (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),[,]`, ainsi que de n'importe quel caractère symbolique ASCII.

Exemples: (Remarque: Les commentaires sont rédigés dans la syntaxe markdown, ce qui implique qu'un bloc de code représente une couche supplémentaire d'accents graves.) \address.city`represents a field namedaddress.city, not the map key villein the fieldadresse. `*`represents a field named*`, et non un champ.

Un Field spécial contient les paramètres d'indexation par défaut de tous les champs. Le nom de ressource de ce champ est projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*. Les index définis sur ce Field seront appliqués à tous les champs qui ne possèdent pas leur propre configuration d'index Field.
indexConfig

object (IndexConfig)

Configuration d'index pour ce champ. Si cette valeur n'est pas définie, l'indexation des champs reprend la configuration définie par ancestorField. Pour supprimer explicitement tous les index de ce champ, spécifiez une configuration d'index avec une liste d'index vide.
ttlConfig

object (TtlConfig)

Configuration TTL pour ce Field. Si vous définissez ou désactivez cette option, la valeur TTL sera activée ou désactivée pour les documents associés à cette Field.

IndexConfig

Configuration d'index pour ce champ.

Représentation JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Champs
indexes[]

object (Index)

Index compatibles avec ce champ.
usesAncestorConfig

boolean

Uniquement en sortie. Lorsque la valeur est "true", la configuration de l'index de Field est définie à partir de la configuration spécifiée par ancestorField. Lorsque la valeur est "false", la configuration d'index de Field est définie explicitement.
ancestorField

string

Uniquement en sortie. Spécifie le nom de la ressource Field à partir de laquelle la configuration d'index de ce champ est définie (lorsque usesAncestorConfig est défini sur "true") ou à partir de laquelle il serait défini si ce champ n'avait pas de configuration d'index (lorsque usesAncestorConfig est défini sur "false").
reverting

boolean

Résultat uniquement. Si la valeur est "true", la configuration de l'index de Field est en cours de rétablissement. Une fois l'opération terminée, la configuration d'index passera au même état que le champ spécifié par ancestorField, où usesAncestorConfig sera true et reverting sera false.

TtlConfig

Configuration de la valeur TTL (Time To Live) pour les documents dont le champ Field est défini.

Le stockage d'une valeur d'horodatage dans un champ compatible TTL sera traité comme le délai d'expiration absolu du document. Les valeurs d'horodatage passées indiquent que le document peut être expiré immédiatement. Si vous utilisez tout autre type de données ou si vous ne renseignez pas ce champ, la date d'expiration est désactivée pour le document concerné.

Représentation JSON 
{
  "state": enum (State)
}
Champs
state

enum (State)

Uniquement en sortie. État de la configuration de la valeur TTL.

État

État de l'application de la configuration TTL à tous les documents.

Enums
STATE_UNSPECIFIED L'état n'est pas spécifié ou est inconnu.
CREATING La valeur TTL est en cours d'application. Une opération de longue durée active permet de suivre la modification. Les valeurs TTL seront appliquées comme demandé pour les documents nouvellement rédigés. Les valeurs TTL demandées pour les documents existants sont toujours en cours de traitement. Lorsque les valeurs TTL de tous les documents existants ont été traitées, l'état passe à "ACTIF".
ACTIVE La valeur TTL est active pour tous les documents.
NEEDS_REPAIR Impossible d'activer la configuration TTL pour tous les documents existants. La valeur TTL continuera d'être appliquée aux documents nouvellement rédigés. Échec de l'opération de longue durée renvoyée lors de la dernière tentative d'activation de la valeur TTL pour ce Field. Des informations supplémentaires peuvent être fournies.

Méthodes

get

 Récupère les métadonnées et la configuration d'un champ.

list

 Répertorie la configuration et les métadonnées des champs pour cette base de données.

patch

 Met à jour une configuration de champ.