Package com.google.cloud.retail.v2

Class CatalogServiceGrpc.CatalogServiceBlockingStub

  • Enclosing class:
    CatalogServiceGrpc
    public static final class CatalogServiceGrpc.CatalogServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<CatalogServiceGrpc.CatalogServiceBlockingStub>
    A stub to allow clients to do synchronous rpc calls to service CatalogService. 
     Service for managing catalog configuration.

    • Method Detail

      • updateCatalog

        public Catalog updateCatalog​(UpdateCatalogRequest request)
         Updates the [Catalog][google.cloud.retail.v2.Catalog]s.

      • setDefaultBranch

        public com.google.protobuf.Empty setDefaultBranch​(SetDefaultBranchRequest request)
         Set a specified branch id as default branch. API methods such as
 [SearchService.Search][google.cloud.retail.v2.SearchService.Search],
 [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct],
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]
 will treat requests using "default_branch" to the actual branch id set as
 default.
 For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as
 default, setting
 [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
 `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent
 to setting
 [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
 `projects/*/locations/*/catalogs/*/branches/1`.
 Using multiple branches can be useful when developers would like
 to have a staging branch to test and verify for future usage. When it
 becomes ready, developers switch on the staging branch using this API while
 keeping using `projects/*/locations/*/catalogs/*/branches/default_branch`
 as [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to
 route the traffic to this staging branch.
 CAUTION: If you have live predict/search traffic, switching the default
 branch could potentially cause outages if the ID space of the new branch is
 very different from the old one.
 More specifically:
 * PredictionService will only return product IDs from branch {newBranch}.
 * SearchService will only return product IDs from branch {newBranch}
   (if branch is not explicitly set).
 * UserEventService will only join events with products from branch
   {newBranch}.

      • getDefaultBranch

        public GetDefaultBranchResponse getDefaultBranch​(GetDefaultBranchRequest request)
         Get which branch is currently default branch set by
 [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
 method under a specified parent catalog.

      • updateAttributesConfig

        public AttributesConfig updateAttributesConfig​(UpdateAttributesConfigRequest request)
         Updates the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
 The catalog attributes in the request will be updated in the catalog, or
 inserted if they do not exist. Existing catalog attributes not included in
 the request will remain unchanged. Attributes that are assigned to
 products, but do not exist at the catalog level, are always included in the
 response. The product attribute is assigned default values for missing
 catalog attribute fields, e.g., searchable and dynamic facetable options.

      • addCatalogAttribute

        public AttributesConfig addCatalogAttribute​(AddCatalogAttributeRequest request)
         Adds the specified
 [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to the
 [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
 If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to add
 already exists, an ALREADY_EXISTS error is returned.

      • removeCatalogAttribute

        public AttributesConfig removeCatalogAttribute​(RemoveCatalogAttributeRequest request)
         Removes the specified
 [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] from the
 [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
 If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
 remove does not exist, a NOT_FOUND error is returned.

      • replaceCatalogAttribute

        public AttributesConfig replaceCatalogAttribute​(ReplaceCatalogAttributeRequest request)
         Replaces the specified
 [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] in the
 [AttributesConfig][google.cloud.retail.v2.AttributesConfig] by updating the
 catalog attribute with the same
 [CatalogAttribute.key][google.cloud.retail.v2.CatalogAttribute.key].
 If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
 replace does not exist, a NOT_FOUND error is returned.