REST Resource: projects.locations.collections.dataStores.branches

Recurso: Branch

Una rama de datos que almacena Documents.

Representación JSON
{
  "name": string,
  "displayName": string,
  "isDefault": boolean,
  "lastDocumentImportTime": string,
  "branchStats": {
    object (BranchStats)
  }
}
Campos
name

string

Inmutable. Nombre completo del recurso de la rama, como projects/*/locations/global/dataStores/dataStore/branches/branchId.

displayName

string

Solo de salida. Nombre legible de la rama que se mostrará en la interfaz de usuario.

isDefault

boolean

Solo de salida. Indica si esta rama se ha definido como la rama predeterminada de su almacén de datos superior.

lastDocumentImportTime

string (Timestamp format)

Solo de salida. Marca de tiempo de la última importación a través de DocumentService.ImportDocuments. Un valor vacío significa que no se ha importado nada a esta rama.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

branchStats

object (BranchStats)

Solo de salida. Estadísticas que describen una sucursal. Este campo no se rellena en la vista [BranchView.BASIC][].

BranchStats

Estadísticas que describen una sucursal.

Representación JSON
{
  "documentCounts": {
    string: string,
    ...
  }
}
Campos
documentCounts

map (key: string, value: string (int64 format))

Número de documentos de una rama determinada.

La clave es un grupo que representa un conjunto de documentos y el valor es el número de documentos de ese grupo. Nota: Las claves de este mapa pueden cambiar con el tiempo. Claves admitidas: ['all'].

Métodos

batchGetDocumentsMetadata

Obtiene los metadatos de actualización del índice de Documents.

get

Obtiene un Branch.

list

Muestra todos los Branchs del DataStore principal especificado.