Retail V2 API - Class Google::Cloud::Retail::V2::SetDefaultBranchRequest (v0.19.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SetDefaultBranchRequest.

Request message to set a specified branch as new default_branch.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#branch_id

def branch_id() -> ::String
Returns
  • (::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.

#branch_id=

def branch_id=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#catalog

def catalog() -> ::String
Returns
  • (::String) — Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.

#catalog=

def catalog=(value) -> ::String
Parameter
  • value (::String) — Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.
Returns
  • (::String) — Full resource name of the catalog, such as projects/*/locations/global/catalogs/default_catalog.

#force

def force() -> ::Boolean
Returns
  • (::Boolean) — If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.

#force=

def force=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
Returns
  • (::Boolean) — If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.

#note

def note() -> ::String
Returns
  • (::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.

#note=

def note=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.