public abstract static class CatalogServiceGrpc.CatalogServiceImplBase implements BindableService
Service for managing catalog configuration.
Implements
io.grpc.BindableServiceConstructors
CatalogServiceImplBase()
public CatalogServiceImplBase()
Methods
bindService()
public final ServerServiceDefinition bindService()
Type | Description |
io.grpc.ServerServiceDefinition |
getDefaultBranch(GetDefaultBranchRequest request, StreamObserver<GetDefaultBranchResponse> responseObserver)
public void getDefaultBranch(GetDefaultBranchRequest request, StreamObserver<GetDefaultBranchResponse> responseObserver)
Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
Name | Description |
request | GetDefaultBranchRequest |
responseObserver | io.grpc.stub.StreamObserver<GetDefaultBranchResponse> |
listCatalogs(ListCatalogsRequest request, StreamObserver<ListCatalogsResponse> responseObserver)
public void listCatalogs(ListCatalogsRequest request, StreamObserver<ListCatalogsResponse> responseObserver)
Lists all the Catalogs associated with the project.
Name | Description |
request | ListCatalogsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListCatalogsResponse> |
setDefaultBranch(SetDefaultBranchRequest request, StreamObserver<Empty> responseObserver)
public void setDefaultBranch(SetDefaultBranchRequest request, StreamObserver<Empty> responseObserver)
Set a specified branch id as default branch. API methods such as
SearchService.Search,
ProductService.GetProduct,
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 to
projects/*/locations/*/catalogs/*/branches/default_branch
is equivalent
to setting
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 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}.
Name | Description |
request | SetDefaultBranchRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
updateCatalog(UpdateCatalogRequest request, StreamObserver<Catalog> responseObserver)
public void updateCatalog(UpdateCatalogRequest request, StreamObserver<Catalog> responseObserver)
Updates the Catalogs.
Name | Description |
request | UpdateCatalogRequest |
responseObserver | io.grpc.stub.StreamObserver<Catalog> |