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 ( |
Champs | |
---|---|
name |
Obligatoire. Un nom de champ au format Un chemin d'accès de champ peut être un simple nom de champ, par exemple Les chemins d'accès des champs peuvent être indiqués à l'aide de 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.) Un |
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 |
ttlConfig |
Configuration TTL pour ce |
IndexConfig
Configuration d'index pour ce champ.
Représentation JSON |
---|
{
"indexes": [
{
object ( |
Champs | |
---|---|
indexes[] |
Index compatibles avec ce champ. |
usesAncestorConfig |
Uniquement en sortie. Lorsque la valeur est "true", la configuration de l'index de |
ancestorField |
Uniquement en sortie. Spécifie le nom de la ressource |
reverting |
Résultat uniquement. Si la valeur est "true", la configuration de l'index de |
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 ( |
Champs | |
---|---|
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. |