Retail v2 API - Class SetDefaultBranchRequest (2.4.0) 

public sealed class SetDefaultBranchRequest : IMessage<SetDefaultBranchRequest>, IEquatable<SetDefaultBranchRequest>, IDeepCloneable<SetDefaultBranchRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class SetDefaultBranchRequest.

Request message to set a specified branch as new default_branch.

Inheritance

Object > SetDefaultBranchRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

SetDefaultBranchRequest()

public SetDefaultBranchRequest()

SetDefaultBranchRequest(SetDefaultBranchRequest)

public SetDefaultBranchRequest(SetDefaultBranchRequest other)
Parameter
NameDescription
otherSetDefaultBranchRequest

Properties

BranchId

public string BranchId { get; set; }

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][google.cloud.retail.v2.SetDefaultBranchRequest.force] is not set, a FAILED_PRECONDITION error is returned.

Property Value
TypeDescription
String

BranchIdAsBranchName

public BranchName BranchIdAsBranchName { get; set; }

BranchName-typed view over the BranchId resource name property.

Property Value
TypeDescription
BranchName

Catalog

public string Catalog { get; set; }

Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.

Property Value
TypeDescription
String

CatalogAsCatalogName

public CatalogName CatalogAsCatalogName { get; set; }

CatalogName-typed view over the Catalog resource name property.

Property Value
TypeDescription
CatalogName

Force

public bool Force { get; set; }

If set to true, it permits switching to a branch with [branch_id][google.cloud.retail.v2.SetDefaultBranchRequest.branch_id] even if it has no sufficient active products.

Property Value
TypeDescription
Boolean

Note

public string Note { get; set; }

Some note on this request, this can be retrieved by [CatalogService.GetDefaultBranch][google.cloud.retail.v2.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.

Property Value
TypeDescription
String