public static final class CatalogServiceGrpc.CatalogServiceFutureStub extends AbstractFutureStub<CatalogServiceGrpc.CatalogServiceFutureStub>
Service for managing catalog configuration.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractFutureStub >
CatalogServiceGrpc.CatalogServiceFutureStub
Inherited Members
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected CatalogServiceGrpc.CatalogServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name | Description |
channel | io.grpc.Channel
|
callOptions | io.grpc.CallOptions
|
Returns
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
getDefaultBranch(GetDefaultBranchRequest request)
public ListenableFuture<GetDefaultBranchResponse> getDefaultBranch(GetDefaultBranchRequest request)
Get which branch is currently default branch set by
CatalogService.SetDefaultBranch
method under a specified parent catalog.
Parameter
Returns
listCatalogs(ListCatalogsRequest request)
public ListenableFuture<ListCatalogsResponse> listCatalogs(ListCatalogsRequest request)
Lists all the Catalogs associated with
the project.
Parameter
Returns
setDefaultBranch(SetDefaultBranchRequest request)
public ListenableFuture<Empty> setDefaultBranch(SetDefaultBranchRequest request)
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}.
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Empty> | |
updateCatalog(UpdateCatalogRequest request)
public ListenableFuture<Catalog> updateCatalog(UpdateCatalogRequest request)
Parameter
Returns
Type | Description |
com.google.common.util.concurrent.ListenableFuture<Catalog> | |