REST Resource: projects.locations.dataStores.branches

Resource: Branch

A data branch that stores Documents.

JSON representation
{
  "name": string,
  "displayName": string,
  "isDefault": boolean,
  "lastDocumentImportTime": string,
  "branchStats": {
    object (BranchStats)
  }
}
Fields
name

string

Immutable. Full resource name of the branch, such as projects/*/locations/global/dataStores/dataStore/branches/branchId.

displayName

string

Output only. Human readable name of the branch to display in the UI.

isDefault

boolean

Output only. Indicates whether this branch is set as the default branch of its parent data store.

lastDocumentImportTime

string (Timestamp format)

Output only. timestamp of last import through DocumentService.ImportDocuments. Empty value means no import has been made to this branch.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

branchStats

object (BranchStats)

Output only. Stistics describing a branch. This field is not populated in [BranchView.BASIC][] view.

Methods

batchGetDocumentsMetadata

Gets index freshness metadata for Documents.

get

Retrieves a Branch.

list

Lists all Branchs under the specified parent DataStore.