public static interface CatalogServiceGrpc.AsyncService
Service for managing catalog configuration.
| Modifier and Type | Method and Description |
|---|---|
default void |
addCatalogAttribute(AddCatalogAttributeRequest request,
io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Adds the specified
[CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to the
[AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
|
default void |
batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request,
io.grpc.stub.StreamObserver<BatchRemoveCatalogAttributesResponse> responseObserver)
Removes all specified
[CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s from the
[AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
|
default void |
getAttributesConfig(GetAttributesConfigRequest request,
io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Gets an [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
|
default void |
getCompletionConfig(GetCompletionConfigRequest request,
io.grpc.stub.StreamObserver<CompletionConfig> responseObserver)
Gets a [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig].
|
default void |
getDefaultBranch(GetDefaultBranchRequest request,
io.grpc.stub.StreamObserver<GetDefaultBranchResponse> responseObserver)
Get which branch is currently default branch set by
[CatalogService.SetDefaultBranch][google.cloud.retail.v2beta.CatalogService.SetDefaultBranch]
method under a specified parent catalog.
|
default void |
listCatalogs(ListCatalogsRequest request,
io.grpc.stub.StreamObserver<ListCatalogsResponse> responseObserver)
Lists all the [Catalog][google.cloud.retail.v2beta.Catalog]s associated
with the project.
|
default void |
removeCatalogAttribute(RemoveCatalogAttributeRequest request,
io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Removes the specified
[CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] from the
[AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
|
default void |
replaceCatalogAttribute(ReplaceCatalogAttributeRequest request,
io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Replaces the specified
[CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] in the
[AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] by updating
the catalog attribute with the same
[CatalogAttribute.key][google.cloud.retail.v2beta.CatalogAttribute.key].
|
default void |
setDefaultBranch(SetDefaultBranchRequest request,
io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Set a specified branch id as default branch.
|
default void |
updateAttributesConfig(UpdateAttributesConfigRequest request,
io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Updates the
[AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
|
default void |
updateCatalog(UpdateCatalogRequest request,
io.grpc.stub.StreamObserver<Catalog> responseObserver)
Updates the [Catalog][google.cloud.retail.v2beta.Catalog]s.
|
default void |
updateCompletionConfig(UpdateCompletionConfigRequest request,
io.grpc.stub.StreamObserver<CompletionConfig> responseObserver)
Updates the
[CompletionConfig][google.cloud.retail.v2beta.CompletionConfig]s.
|
default void listCatalogs(ListCatalogsRequest request, io.grpc.stub.StreamObserver<ListCatalogsResponse> responseObserver)
Lists all the [Catalog][google.cloud.retail.v2beta.Catalog]s associated with the project.
default void updateCatalog(UpdateCatalogRequest request, io.grpc.stub.StreamObserver<Catalog> responseObserver)
Updates the [Catalog][google.cloud.retail.v2beta.Catalog]s.
default void setDefaultBranch(SetDefaultBranchRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Set a specified branch id as default branch. API methods such as
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search],
[ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct],
[ProductService.ListProducts][google.cloud.retail.v2beta.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.v2beta.SearchRequest.branch] to
`projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent
to setting
[SearchRequest.branch][google.cloud.retail.v2beta.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.v2beta.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}.
default void getDefaultBranch(GetDefaultBranchRequest request, io.grpc.stub.StreamObserver<GetDefaultBranchResponse> responseObserver)
Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2beta.CatalogService.SetDefaultBranch] method under a specified parent catalog.
default void getCompletionConfig(GetCompletionConfigRequest request, io.grpc.stub.StreamObserver<CompletionConfig> responseObserver)
Gets a [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig].
default void updateCompletionConfig(UpdateCompletionConfigRequest request, io.grpc.stub.StreamObserver<CompletionConfig> responseObserver)
Updates the [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig]s.
default void getAttributesConfig(GetAttributesConfigRequest request, io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Gets an [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
default void updateAttributesConfig(UpdateAttributesConfigRequest request, io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Updates the [AttributesConfig][google.cloud.retail.v2beta.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.
default void addCatalogAttribute(AddCatalogAttributeRequest request, io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Adds the specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig]. If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned.
default void removeCatalogAttribute(RemoveCatalogAttributeRequest request, io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Removes the specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig]. If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to remove does not exist, a NOT_FOUND error is returned.
default void batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request, io.grpc.stub.StreamObserver<BatchRemoveCatalogAttributesResponse> responseObserver)
Removes all specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s from the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
default void replaceCatalogAttribute(ReplaceCatalogAttributeRequest request, io.grpc.stub.StreamObserver<AttributesConfig> responseObserver)
Replaces the specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] in the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] by updating the catalog attribute with the same [CatalogAttribute.key][google.cloud.retail.v2beta.CatalogAttribute.key]. If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to replace does not exist, a NOT_FOUND error is returned.
Copyright © 2024 Google LLC. All rights reserved.