Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.list

  Path : v1alpha/{+parent}/branches

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The parent data store resource name.

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$

  Location : path

  Required : Yes

  Type : string

  view

  Description : The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.

  Location : query

  Type : string

  Enum Descriptions :

  • The value when it's unspecified. This defaults to the BASIC view.
  • Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
  • Includes all fields of a Branch.

  Enum :

  • BRANCH_VIEW_UNSPECIFIED
  • BRANCH_VIEW_BASIC
  • BRANCH_VIEW_FULL

  Parameter Order : parent

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Lists all Branchs under the specified parent DataStore.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.get

  Path : v1alpha/{+name}

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document.

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$

  Location : path

  Required : Yes

  Type : string

  view

  Description : The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.

  Location : query

  Type : string

  Enum Descriptions :

  • The value when it's unspecified. This defaults to the BASIC view.
  • Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
  • Includes all fields of a Branch.

  Enum :

  • BRANCH_VIEW_UNSPECIFIED
  • BRANCH_VIEW_BASIC
  • BRANCH_VIEW_FULL

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Retrieves a Branch.

• ▼ ▲ discoveryengine.projects.locations.dataStores.branches.list

  Path : v1alpha/{+parent}/branches

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches

  HTTP Method : GET

  Parameters :

  parent

  Description : Required. The parent data store resource name.

  Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$

  Location : path

  Required : Yes

  Type : string

  view

  Description : The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.

  Location : query

  Type : string

  Enum Descriptions :

  • The value when it's unspecified. This defaults to the BASIC view.
  • Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
  • Includes all fields of a Branch.

  Enum :

  • BRANCH_VIEW_UNSPECIFIED
  • BRANCH_VIEW_BASIC
  • BRANCH_VIEW_FULL

  Parameter Order : parent

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Lists all Branchs under the specified parent DataStore.

• ▼ ▲ discoveryengine.projects.locations.dataStores.branches.get

  Path : v1alpha/{+name}

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}

  HTTP Method : GET

  Parameters :

  name

  Description : Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document.

  Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$

  Location : path

  Required : Yes

  Type : string

  view

  Description : The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.

  Location : query

  Type : string

  Enum Descriptions :

  • The value when it's unspecified. This defaults to the BASIC view.
  • Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.
  • Includes all fields of a Branch.

  Enum :

  • BRANCH_VIEW_UNSPECIFIED
  • BRANCH_VIEW_BASIC
  • BRANCH_VIEW_FULL

  Parameter Order : name

  Scopes : https://www.googleapis.com/auth/cloud-platform

  Description : Retrieves a Branch.