Skip to main content

catalogs_default_branch

Creates, updates, deletes, gets or lists a catalogs_default_branch resource.

Overview

Namecatalogs_default_branch
TypeResource
Idgoogle.retail.catalogs_default_branch

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
branchstringFull resource name of the branch id currently set as default branch.
notestringThis corresponds to SetDefaultBranchRequest.note field, when this branch was set as default.
setTimestring (google-datetime)The time when this branch is set to default.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_catalogs_get_default_branchselectprojectsId, locationsId, catalogsIdGet which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
catalogsIdstring
locationsIdstring
projectsIdstring

SELECT examples

Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

SELECT
branch,
note,
setTime
FROM google.retail.catalogs_default_branch
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND catalogsId = '{{ catalogsId }}' -- required;