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

Recurso: Branch

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 salida. Nombre legible por humanos de la rama que se mostrará en la IU.

isDefault

boolean

Solo salida. Indica si esta rama está establecida como la rama predeterminada de su almacén de datos principal.

lastDocumentImportTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la última importación a través de DocumentService.ImportDocuments. Un valor vacío significa que no se realizó ninguna importación en esta rama.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “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 salida. Son las estadísticas que describen una rama. Este campo no se completa en la vista [BranchView.BASIC][].

BranchStats

Son estadísticas que describen una rama.

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

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

Es la cantidad de documentos en una rama determinada.

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

Métodos

batchGetDocumentsMetadata

Obtiene los metadatos de actualidad del índice para los Document.

get

Recupera un objeto Branch.

list

Enumera todos los objetos Branch en el objeto principal DataStore especificado.