FieldOperationMetadata

Metadatos de google.longrunning.Operation resultados 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 “Zulú”, 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 en que se completó esta operación. No se establecerá si la operación aún está en curso.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, 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 el intent de esta operación.
state

enum (OperationState)

El estado de la operación.
progressDocuments

object (Progress)

El progreso, 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 del TTL.

IndexConfigDelta

Información sobre un cambio en la configuración de índices.

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

enum (ChangeType)

Especifica cómo cambia el índice.
index

object (Index)

El índice que se cambia.

Índice

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

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

string

Solo salida. Es un nombre definido por el servidor para este índice. La forma de este nombre para los índices compuestos será la siguiente: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} En el caso de los índices de campo único, este campo estará vacío.
queryScope

enum (QueryScope)

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

Los índices con un alcance de consulta de grupo de colecciones especificado permiten realizar consultas en todas las colecciones que descienden de un documento específico, que se especifican en el momento de la consulta y que tienen el mismo ID de colección que este índice.
apiScope

enum (ApiScope)

El alcance de la API que admite este índice.
fields[]

object (IndexField)

Los campos que admite este índice.

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

En el caso de los índices de campo único, esto siempre será exactamente una entrada con una ruta de campo igual a la del campo asociado.
state

enum (State)

Solo salida. El estado de entrega del índice.

IndexField

Un campo en un índice. La fieldPath describe qué campo está indexado, mientras que 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 name. En el caso de los índices de campo único, debe coincidir con el nombre del campo o puede omitirse.
Campo de unión value_mode. Cómo se indexa el valor del campo. Las direcciones (value_mode) solo pueden ser una de las siguientes opciones:
order

enum (Order)

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

enum (ArrayConfig)

Indica que este campo admite operaciones en arrayValue.
vectorConfig

object (VectorConfig)

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

VectorConfig

La configuración del índice para admitir 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

Obligatorio. 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 usar para realizar búsquedas vectoriales con la misma dimensión.
Campo de unión type. Es el tipo de índice que se usa. Las direcciones (type) solo pueden ser una de las siguientes opciones:
flat

object (FlatIndex)

Indica que el índice vectorial es un índice plano.

FlatIndex

Este tipo no tiene campos.

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

TtlConfigDelta

Información sobre un cambio en la configuración del TTL.

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

enum (ChangeType)

Especifica cómo cambia la configuración del TTL.