public static final class CatalogServiceGrpc.CatalogServiceBlockingStub extends AbstractBlockingStub<CatalogServiceGrpc.CatalogServiceBlockingStub>
A stub to allow clients to do synchronous rpc calls to service CatalogService.
Service for managing catalog configuration.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
CatalogServiceGrpc.CatalogServiceBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<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
addCatalogAttribute(AddCatalogAttributeRequest request)
public AttributesConfig addCatalogAttribute(AddCatalogAttributeRequest request)
Adds the specified
CatalogAttribute to the
AttributesConfig.
If the CatalogAttribute to
add already exists, an ALREADY_EXISTS error is returned.
batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request)
public BatchRemoveCatalogAttributesResponse batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request)
Removes all specified
CatalogAttributes from the
AttributesConfig.
build(Channel channel, CallOptions callOptions)
protected CatalogServiceGrpc.CatalogServiceBlockingStub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
getAttributesConfig(GetAttributesConfigRequest request)
public AttributesConfig getAttributesConfig(GetAttributesConfigRequest request)
Gets an AttributesConfig.
getCompletionConfig(GetCompletionConfigRequest request)
public CompletionConfig getCompletionConfig(GetCompletionConfigRequest request)
getDefaultBranch(GetDefaultBranchRequest request)
public GetDefaultBranchResponse getDefaultBranch(GetDefaultBranchRequest request)
Get which branch is currently default branch set by
CatalogService.SetDefaultBranch
method under a specified parent catalog.
listCatalogs(ListCatalogsRequest request)
public ListCatalogsResponse listCatalogs(ListCatalogsRequest request)
Lists all the Catalogs associated
with the project.
removeCatalogAttribute(RemoveCatalogAttributeRequest request)
public AttributesConfig removeCatalogAttribute(RemoveCatalogAttributeRequest request)
Removes the specified
CatalogAttribute from the
AttributesConfig.
If the CatalogAttribute to
remove does not exist, a NOT_FOUND error is returned.
replaceCatalogAttribute(ReplaceCatalogAttributeRequest request)
public AttributesConfig replaceCatalogAttribute(ReplaceCatalogAttributeRequest request)
Replaces the specified
CatalogAttribute in the
AttributesConfig by updating
the catalog attribute with the same
CatalogAttribute.key.
If the CatalogAttribute to
replace does not exist, a NOT_FOUND error is returned.
setDefaultBranch(SetDefaultBranchRequest request)
public 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}.
| Returns |
| Type |
Description |
Empty |
|
updateAttributesConfig(UpdateAttributesConfigRequest request)
public AttributesConfig updateAttributesConfig(UpdateAttributesConfigRequest request)
Updates the
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.
updateCatalog(UpdateCatalogRequest request)
public Catalog updateCatalog(UpdateCatalogRequest request)
updateCompletionConfig(UpdateCompletionConfigRequest request)
public CompletionConfig updateCompletionConfig(UpdateCompletionConfigRequest request)
Updates the
CompletionConfigs.
