View Source GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SetDefaultBranchRequest (google_api_retail v0.10.0)

Request message to set a specified branch as new default_branch.

Attributes

branchId (type: String.t, default: nil) - 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.
force (type: boolean(), default: nil) - If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
note (type: String.t, default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Retail.V2.Model.GoogleCloudRetailV2SetDefaultBranchRequest{
  branchId: String.t() | nil,
  force: boolean() | nil,
  note: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.