- 2.57.0 (latest)
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static interface CatalogServiceGrpc.AsyncServiceService for managing catalog configuration.
Methods
addCatalogAttribute(AddCatalogAttributeRequest request, StreamObserver<AttributesConfig> responseObserver)
public default void addCatalogAttribute(AddCatalogAttributeRequest request, StreamObserver<AttributesConfig> responseObserver)Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
| Parameters | |
|---|---|
| Name | Description |
request | AddCatalogAttributeRequest |
responseObserver | io.grpc.stub.StreamObserver<AttributesConfig> |
batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request, StreamObserver<BatchRemoveCatalogAttributesResponse> responseObserver)
public default void batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request, StreamObserver<BatchRemoveCatalogAttributesResponse> responseObserver)Removes all specified CatalogAttributes from the AttributesConfig.
| Parameters | |
|---|---|
| Name | Description |
request | BatchRemoveCatalogAttributesRequest |
responseObserver | io.grpc.stub.StreamObserver<BatchRemoveCatalogAttributesResponse> |
getAttributesConfig(GetAttributesConfigRequest request, StreamObserver<AttributesConfig> responseObserver)
public default void getAttributesConfig(GetAttributesConfigRequest request, StreamObserver<AttributesConfig> responseObserver)Gets an AttributesConfig.
| Parameters | |
|---|---|
| Name | Description |
request | GetAttributesConfigRequest |
responseObserver | io.grpc.stub.StreamObserver<AttributesConfig> |
getCompletionConfig(GetCompletionConfigRequest request, StreamObserver<CompletionConfig> responseObserver)
public default void getCompletionConfig(GetCompletionConfigRequest request, StreamObserver<CompletionConfig> responseObserver)Gets a CompletionConfig.
| Parameters | |
|---|---|
| Name | Description |
request | GetCompletionConfigRequest |
responseObserver | io.grpc.stub.StreamObserver<CompletionConfig> |
getDefaultBranch(GetDefaultBranchRequest request, StreamObserver<GetDefaultBranchResponse> responseObserver)
public default void getDefaultBranch(GetDefaultBranchRequest request, StreamObserver<GetDefaultBranchResponse> responseObserver)Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
| Parameters | |
|---|---|
| Name | Description |
request | GetDefaultBranchRequest |
responseObserver | io.grpc.stub.StreamObserver<GetDefaultBranchResponse> |
listCatalogs(ListCatalogsRequest request, StreamObserver<ListCatalogsResponse> responseObserver)
public default void listCatalogs(ListCatalogsRequest request, StreamObserver<ListCatalogsResponse> responseObserver)Lists all the Catalogs associated with the project.
| Parameters | |
|---|---|
| Name | Description |
request | ListCatalogsRequest |
responseObserver | io.grpc.stub.StreamObserver<ListCatalogsResponse> |
removeCatalogAttribute(RemoveCatalogAttributeRequest request, StreamObserver<AttributesConfig> responseObserver)
public default void removeCatalogAttribute(RemoveCatalogAttributeRequest request, StreamObserver<AttributesConfig> responseObserver)Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
| Parameters | |
|---|---|
| Name | Description |
request | RemoveCatalogAttributeRequest |
responseObserver | io.grpc.stub.StreamObserver<AttributesConfig> |
replaceCatalogAttribute(ReplaceCatalogAttributeRequest request, StreamObserver<AttributesConfig> responseObserver)
public default void replaceCatalogAttribute(ReplaceCatalogAttributeRequest request, StreamObserver<AttributesConfig> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | ReplaceCatalogAttributeRequest |
responseObserver | io.grpc.stub.StreamObserver<AttributesConfig> |
setDefaultBranch(SetDefaultBranchRequest request, StreamObserver<Empty> responseObserver)
public default 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}.
| Parameters | |
|---|---|
| Name | Description |
request | SetDefaultBranchRequest |
responseObserver | io.grpc.stub.StreamObserver<Empty> |
updateAttributesConfig(UpdateAttributesConfigRequest request, StreamObserver<AttributesConfig> responseObserver)
public default void updateAttributesConfig(UpdateAttributesConfigRequest request, StreamObserver<AttributesConfig> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateAttributesConfigRequest |
responseObserver | io.grpc.stub.StreamObserver<AttributesConfig> |
updateCatalog(UpdateCatalogRequest request, StreamObserver<Catalog> responseObserver)
public default void updateCatalog(UpdateCatalogRequest request, StreamObserver<Catalog> responseObserver)Updates the Catalogs.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateCatalogRequest |
responseObserver | io.grpc.stub.StreamObserver<Catalog> |
updateCompletionConfig(UpdateCompletionConfigRequest request, StreamObserver<CompletionConfig> responseObserver)
public default void updateCompletionConfig(UpdateCompletionConfigRequest request, StreamObserver<CompletionConfig> responseObserver)Updates the CompletionConfigs.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateCompletionConfigRequest |
responseObserver | io.grpc.stub.StreamObserver<CompletionConfig> |