Reference documentation and code samples for the Google Cloud Retail V2 Client class SetDefaultBranchRequest.
Request message to set a specified branch as new default_branch.
Generated from protobuf message google.cloud.retail.v2.SetDefaultBranchRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ catalog |
string
Full resource name of the catalog, such as |
↳ branch_id |
string
The final component of the resource name of a branch. This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned. |
↳ note |
string
Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
↳ force |
bool
If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products. |
getCatalog
Full resource name of the catalog, such as
projects/*/locations/global/catalogs/default_catalog.
| Returns | |
|---|---|
| Type | Description |
string | |
setCatalog
Full resource name of the catalog, such as
projects/*/locations/global/catalogs/default_catalog.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBranchId
The final component of the resource name of a branch.
This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setBranchId
The final component of the resource name of a branch.
This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNote
Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs.
This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
string | |
setNote
Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs.
This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getForce
If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
| Returns | |
|---|---|
| Type | Description |
bool | |
setForce
If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |