FieldOperationMetadata

Metadatos de los resultados de google.longrunning.Operation de FirestoreAdmin.UpdateField .

Representación JSON
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Campos
startTime

string ( Timestamp format)

La hora en que comenzó esta operación.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

field

string

El recurso de campo sobre el que actúa esta operación. Por ejemplo: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object ( IndexConfigDelta )

Una lista de IndexConfigDelta , que describe la intención de esta operación.

state

enum ( OperationState )

El estado de la operación.

progressDocuments

object ( Progress )

Los avances, en documentos, de esta operación.

progressBytes

object ( Progress )

El progreso, en bytes, de esta operación.

ttlConfigDelta

object ( TtlConfigDelta )

Describe los deltas de la configuración TTL.

ÍndiceConfigDelta

Información sobre un cambio de configuración de índice.

Representación JSON
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Campos
changeType

enum ( ChangeType )

Especifica cómo está cambiando el índice.

index

object ( Index )

El índice está siendo cambiado.

Índice

Los índices de Cloud Firestore permiten consultas simples y complejas en documentos en una base de datos.

Representación JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Campos
name

string

Sólo salida. Un nombre definido por el servidor para este índice. La forma de este nombre para índices compuestos será: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Para índices de campo único, este campo estará vacío.

queryScope

enum ( QueryScope )

Los índices con un alcance de consulta de colección especificado permiten consultas en una colección que es hija de un documento específico, especificada en el momento de la consulta y que tiene el mismo ID de colección.

Los índices con un alcance de consulta de grupo de colección especificado permiten consultas en todas las colecciones que descienden de un documento específico, especificadas en el momento de la consulta y que tienen la misma identificación de colección que este índice.

apiScope

enum ( ApiScope )

El alcance de la API admitido por este índice.

fields[]

object ( IndexField )

Los campos soportados por este índice.

Para índices compuestos, esto requiere un mínimo de 2 y un máximo de 100 campos. La última entrada de campo es siempre para la ruta del campo __name__ . Si en el momento de la creación no se especificó __name__ como último campo, se agregará automáticamente con la misma dirección que la del último campo definido. Si el campo final en un índice compuesto no es direccional, el __name__ se ordenará ASCENDENTE (a menos que se especifique explícitamente).

Para índices de campo único, siempre será exactamente una entrada con una ruta de campo igual a la ruta del campo asociado.

state

enum ( State )

Sólo salida. El estado de servicio del índice.

Campo de índice

Un campo en un índice. fieldPath describe qué campo está indexado, value_mode describe cómo se indexa el valor del campo.

Representación 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.
}
Campos
fieldPath

string

Puede ser nombre . Para índices de campo único, esto debe coincidir con el nombre del campo o puede omitirse.

Campo de unión value_mode . Cómo se indexa el valor del campo. value_mode puede ser solo uno de los siguientes:
order

enum ( Order )

Indica que este campo admite ordenar según el orden especificado o comparar usando =, !=, <, <=, >, >=.

arrayConfig

enum ( ArrayConfig )

Indica que este campo admite operaciones en arrayValue s.

vectorConfig

object ( VectorConfig )

Indica que este campo admite vecinos más cercanos y operaciones de distancia en vectores.

Configuración vectorial

La configuración del índice para soportar operaciones de búsqueda vectorial.

Representación 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.
}
Campos
dimension

integer

Requerido. La dimensión vectorial a la que se aplica esta configuración.

El índice resultante solo incluirá vectores de esta dimensión y se puede utilizar para la búsqueda de vectores con la misma dimensión.

type de campo de unión. El tipo de índice utilizado. type puede ser sólo uno de los siguientes:
flat

object ( FlatIndex )

Indica que el índice del vector es un índice plano.

Índice plano

Este tipo no tiene campos.

Un índice que almacena vectores en una estructura de datos plana y admite búsquedas exhaustivas.

TtlConfigDelta

Información sobre un cambio de configuración TTL.

Representación JSON
{
  "changeType": enum (ChangeType)
}
Campos
changeType

enum ( ChangeType )

Especifica cómo está cambiando la configuración TTL.