FieldOperationMetadata

Métadonnées pour les résultats google.longrunning.Operation de FirestoreAdmin.UpdateField.

Représentation JSON 
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Champs
startTime

string (Timestamp format)

Heure de début de l'opération.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Heure à laquelle cette opération s'est terminée. Ne sera pas défini si une opération est toujours en cours.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
field

string

Ressource de champ sur laquelle cette opération agit. Par exemple : projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}
indexConfigDeltas[]

object (IndexConfigDelta)

Liste de IndexConfigDelta, qui décrivent le but de cette opération.
state

enum (OperationState)

État de l'opération.
progressDocuments

object (Progress)

La progression, dans les documents, de cette opération.
progressBytes

object (Progress)

Progression, en octets, de cette opération.
ttlConfigDelta

object (TtlConfigDelta)

Décrit les deltas de la configuration TTL.

IndexConfigDelta

Informations sur une modification de la configuration d'index.

Représentation JSON 
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Champs
changeType

enum (ChangeType)

Spécifie la modification de l'index.
index

object (Index)

Index en cours de modification.

Index

Les index Cloud Firestore permettent d'exécuter des requêtes simples et complexes sur les documents d'une base de données.

Représentation JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Champs
name

string

Uniquement en sortie. Nom défini par le serveur pour cet index. Ce nom pour les index composites prendra la forme suivante: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Pour les index à champ unique, ce champ sera vide.
queryScope

enum (QueryScope)

Les index dont le champ d'application de requête de collection est spécifié autorisent les requêtes sur une collection enfant d'un document spécifique, spécifié au moment de la requête, et possédant le même ID de collection.

Les index dont le champ d'application de requête de groupe de collections est spécifié autorisent les requêtes sur toutes les collections descendant d'un document spécifique, spécifié au moment de la requête et ayant le même ID de collection que cet index.
apiScope

enum (ApiScope)

Champ d'application d'API accepté par cet index.
fields[]

object (IndexField)

Champs acceptés par cet index.

Pour les index composites, cela nécessite un minimum de 2 et un maximum de 100 champs. La dernière entrée de champ correspond toujours au chemin d'accès du champ __name__. Si, lors de la création, __name__ n'a pas été spécifié comme dernier champ, il sera ajouté automatiquement dans la même direction que celle du dernier champ défini. Si le dernier champ d'un index composite n'est pas directionnel, __name__ sera classé par ordre croissant dans l'ordre décroissant (sauf indication contraire explicite).

Pour les index à champ unique, il s'agira toujours d'une seule entrée dont le chemin d'accès de champ correspond à celui du champ associé.
state

enum (State)

Uniquement en sortie. État de diffusion de l'index.

IndexField

Champ d'un index. Le champ fieldPath décrit le champ indexé et le champ value_mode décrit la manière dont la valeur du champ est indexée.

Représentation JSON 
{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}
Champs
fieldPath

string

Il peut s'agir de name. Pour les index à champ unique, il doit correspondre au nom du champ ou peut être omis.
Champ d'union value_mode. Manière dont la valeur du champ est indexée. value_mode ne peut être qu'un des éléments suivants :
order

enum (Order)

Indique que ce champ permet de trier par ordre spécifié ou de comparer en utilisant =, !=, <, <=, >, >=.
arrayConfig

enum (ArrayConfig)

Indique que ce champ accepte les opérations sur les arrayValue.
vectorConfig

object (VectorConfig)

Indique que ce champ accepte les opérations de voisinage les plus proches et de distance sur les vecteurs.

VectorConfig

Configuration d'index compatible avec les opérations de recherche vectorielle

Représentation JSON 
{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}
Champs
dimension

integer

Obligatoire. Dimension vectorielle à laquelle cette configuration s'applique.

L'index obtenu n'inclura que les vecteurs de cette dimension et peut être utilisé pour la recherche vectorielle avec la même dimension.
Champ d'union type. Type d'index utilisé. type ne peut être qu'un des éléments suivants :
flat

object (FlatIndex)

Indique que l'index vectoriel est un index plat.

FlatIndex

Ce type ne comporte aucun champ.

Index qui stocke les vecteurs dans une structure de données plate et prend en charge la recherche exhaustive.

TtlConfigDelta

Informations sur une modification de la configuration TTL.

Représentation JSON 
{
  "changeType": enum (ChangeType)
}
Champs
changeType

enum (ChangeType)

Spécifie les modifications apportées à la configuration TTL.