- 2.50.0 (latest)
- 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
A client to Retail API
The interfaces provided are listed below, along with usage samples.
CatalogServiceClient
Service Description: Service for managing catalog configuration.
Sample for CatalogServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
Catalog catalog = Catalog.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Catalog response = catalogServiceClient.updateCatalog(catalog, updateMask);
}
CompletionServiceClient
Service Description: Auto-completion service for retail.
This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Sample for CompletionServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
CompleteQueryRequest request =
CompleteQueryRequest.newBuilder()
.setCatalog(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setQuery("query107944136")
.setVisitorId("visitorId1880545833")
.addAllLanguageCodes(new ArrayList<String>())
.setDeviceType("deviceType781190832")
.setDataset("dataset1443214456")
.setMaxSuggestions(618824852)
.build();
CompleteQueryResponse response = completionServiceClient.completeQuery(request);
}
ControlServiceClient
Service Description: Service for modifying Control.
Sample for ControlServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
Control control = Control.newBuilder().build();
String controlId = "controlId-395080872";
Control response = controlServiceClient.createControl(parent, control, controlId);
}
ModelServiceClient
Service Description: Service for performing CRUD operations on models. Recommendation models
contain all the metadata necessary to generate a set of models for the Predict()
API. A model
is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g.
Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
Sample for ModelServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]");
Model response = modelServiceClient.pauseModel(name);
}
PredictionServiceClient
Service Description: Service for making recommendation prediction.
Sample for PredictionServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
PredictRequest request =
PredictRequest.newBuilder()
.setPlacement("placement1792938725")
.setUserEvent(UserEvent.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setValidateOnly(true)
.putAllParams(new HashMap<String, Value>())
.putAllLabels(new HashMap<String, String>())
.build();
PredictResponse response = predictionServiceClient.predict(request);
}
ProductServiceClient
Service Description: Service for ingesting Product information of the customer's website.
Sample for ProductServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ProductServiceClient productServiceClient = ProductServiceClient.create()) {
BranchName parent = BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]");
Product product = Product.newBuilder().build();
String productId = "productId-1051830678";
Product response = productServiceClient.createProduct(parent, product, productId);
}
SearchServiceClient
Service Description: Service for search.
This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Sample for SearchServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
SearchRequest request =
SearchRequest.newBuilder()
.setPlacement("placement1792938725")
.setBranch(
BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
.setQuery("query107944136")
.setVisitorId("visitorId1880545833")
.setUserInfo(UserInfo.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOffset(-1019779949)
.setFilter("filter-1274492040")
.setCanonicalFilter("canonicalFilter-722283124")
.setOrderBy("orderBy-1207110587")
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
.setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.newBuilder().build())
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
.addAllVariantRollupKeys(new ArrayList<String>())
.addAllPageCategories(new ArrayList<String>())
.setPersonalizationSpec(SearchRequest.PersonalizationSpec.newBuilder().build())
.putAllLabels(new HashMap<String, String>())
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
.build();
for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
// doThingsWith(element);
}
}
ServingConfigServiceClient
Service Description: Service for modifying ServingConfig.
Sample for ServingConfigServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServingConfigServiceClient servingConfigServiceClient =
ServingConfigServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
ServingConfig servingConfig = ServingConfig.newBuilder().build();
String servingConfigId = "servingConfigId-831052759";
ServingConfig response =
servingConfigServiceClient.createServingConfig(parent, servingConfig, servingConfigId);
}
UserEventServiceClient
Service Description: Service for ingesting end user actions on the customer website.
Sample for UserEventServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder()
.setParent("parent-995424086")
.setUserEvent(UserEvent.newBuilder().build())
.build();
UserEvent response = userEventServiceClient.writeUserEvent(request);
}
Classes
AddCatalogAttributeRequest
Request for CatalogService.AddCatalogAttribute method.
Protobuf type google.cloud.retail.v2beta.AddCatalogAttributeRequest
AddCatalogAttributeRequest.Builder
Request for CatalogService.AddCatalogAttribute method.
Protobuf type google.cloud.retail.v2beta.AddCatalogAttributeRequest
AddControlRequest
Request for AddControl method.
Protobuf type google.cloud.retail.v2beta.AddControlRequest
AddControlRequest.Builder
Request for AddControl method.
Protobuf type google.cloud.retail.v2beta.AddControlRequest
AddFulfillmentPlacesMetadata
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.AddFulfillmentPlacesMetadata
AddFulfillmentPlacesMetadata.Builder
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.AddFulfillmentPlacesMetadata
AddFulfillmentPlacesRequest
Request message for ProductService.AddFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.AddFulfillmentPlacesRequest
AddFulfillmentPlacesRequest.Builder
Request message for ProductService.AddFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.AddFulfillmentPlacesRequest
AddFulfillmentPlacesResponse
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.AddFulfillmentPlacesResponse
AddFulfillmentPlacesResponse.Builder
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.AddFulfillmentPlacesResponse
AddLocalInventoriesMetadata
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.
Protobuf type google.cloud.retail.v2beta.AddLocalInventoriesMetadata
AddLocalInventoriesMetadata.Builder
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.
Protobuf type google.cloud.retail.v2beta.AddLocalInventoriesMetadata
AddLocalInventoriesRequest
Request message for ProductService.AddLocalInventories method.
Protobuf type google.cloud.retail.v2beta.AddLocalInventoriesRequest
AddLocalInventoriesRequest.Builder
Request message for ProductService.AddLocalInventories method.
Protobuf type google.cloud.retail.v2beta.AddLocalInventoriesRequest
AddLocalInventoriesResponse
Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.
Protobuf type google.cloud.retail.v2beta.AddLocalInventoriesResponse
AddLocalInventoriesResponse.Builder
Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.
Protobuf type google.cloud.retail.v2beta.AddLocalInventoriesResponse
AttributesConfig
Catalog level attribute config.
Protobuf type google.cloud.retail.v2beta.AttributesConfig
AttributesConfig.Builder
Catalog level attribute config.
Protobuf type google.cloud.retail.v2beta.AttributesConfig
AttributesConfigName
AttributesConfigName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/attributesConfig.
Audience
An intended audience of the Product for whom it's sold.
Protobuf type google.cloud.retail.v2beta.Audience
Audience.Builder
An intended audience of the Product for whom it's sold.
Protobuf type google.cloud.retail.v2beta.Audience
BatchRemoveCatalogAttributesRequest
Request for CatalogService.BatchRemoveCatalogAttributes method.
Protobuf type google.cloud.retail.v2beta.BatchRemoveCatalogAttributesRequest
BatchRemoveCatalogAttributesRequest.Builder
Request for CatalogService.BatchRemoveCatalogAttributes method.
Protobuf type google.cloud.retail.v2beta.BatchRemoveCatalogAttributesRequest
BatchRemoveCatalogAttributesResponse
Response of the CatalogService.BatchRemoveCatalogAttributes.
Protobuf type google.cloud.retail.v2beta.BatchRemoveCatalogAttributesResponse
BatchRemoveCatalogAttributesResponse.Builder
Response of the CatalogService.BatchRemoveCatalogAttributes.
Protobuf type google.cloud.retail.v2beta.BatchRemoveCatalogAttributesResponse
BigQueryOutputResult
A BigQuery output result.
Protobuf type google.cloud.retail.v2beta.BigQueryOutputResult
BigQueryOutputResult.Builder
A BigQuery output result.
Protobuf type google.cloud.retail.v2beta.BigQueryOutputResult
BigQuerySource
BigQuery source import data from.
Protobuf type google.cloud.retail.v2beta.BigQuerySource
BigQuerySource.Builder
BigQuery source import data from.
Protobuf type google.cloud.retail.v2beta.BigQuerySource
BranchName
BranchName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}.
Catalog
The catalog configuration.
Protobuf type google.cloud.retail.v2beta.Catalog
Catalog.Builder
The catalog configuration.
Protobuf type google.cloud.retail.v2beta.Catalog
CatalogAttribute
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Protobuf type google.cloud.retail.v2beta.CatalogAttribute
CatalogAttribute.Builder
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Protobuf type google.cloud.retail.v2beta.CatalogAttribute
CatalogName
CatalogName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}.
CatalogProto
CatalogServiceClient
Service Description: Service for managing catalog configuration.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
Catalog catalog = Catalog.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Catalog response = catalogServiceClient.updateCatalog(catalog, updateMask);
}
Note: close() needs to be called on the CatalogServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of CatalogServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CatalogServiceSettings catalogServiceSettings =
CatalogServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CatalogServiceSettings catalogServiceSettings =
CatalogServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CatalogServiceSettings catalogServiceSettings =
CatalogServiceSettings.newBuilder()
.setTransportChannelProvider(
CatalogServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
CatalogServiceClient.ListCatalogsFixedSizeCollection
CatalogServiceClient.ListCatalogsPage
CatalogServiceClient.ListCatalogsPagedResponse
CatalogServiceGrpc
Service for managing catalog configuration.
CatalogServiceGrpc.CatalogServiceBlockingStub
Service for managing catalog configuration.
CatalogServiceGrpc.CatalogServiceFutureStub
Service for managing catalog configuration.
CatalogServiceGrpc.CatalogServiceImplBase
Service for managing catalog configuration.
CatalogServiceGrpc.CatalogServiceStub
Service for managing catalog configuration.
CatalogServiceProto
CatalogServiceSettings
Settings class to configure an instance of CatalogServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of updateCatalog to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CatalogServiceSettings.Builder catalogServiceSettingsBuilder =
CatalogServiceSettings.newBuilder();
catalogServiceSettingsBuilder
.updateCatalogSettings()
.setRetrySettings(
catalogServiceSettingsBuilder.updateCatalogSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CatalogServiceSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();
CatalogServiceSettings.Builder
Builder for CatalogServiceSettings.
CollectUserEventRequest
Request message for CollectUserEvent method.
Protobuf type google.cloud.retail.v2beta.CollectUserEventRequest
CollectUserEventRequest.Builder
Request message for CollectUserEvent method.
Protobuf type google.cloud.retail.v2beta.CollectUserEventRequest
ColorInfo
The color information of a Product.
Protobuf type google.cloud.retail.v2beta.ColorInfo
ColorInfo.Builder
The color information of a Product.
Protobuf type google.cloud.retail.v2beta.ColorInfo
CommonProto
CompleteQueryRequest
Auto-complete parameters.
Protobuf type google.cloud.retail.v2beta.CompleteQueryRequest
CompleteQueryRequest.Builder
Auto-complete parameters.
Protobuf type google.cloud.retail.v2beta.CompleteQueryRequest
CompleteQueryResponse
Response of the auto-complete query.
Protobuf type google.cloud.retail.v2beta.CompleteQueryResponse
CompleteQueryResponse.Builder
Response of the auto-complete query.
Protobuf type google.cloud.retail.v2beta.CompleteQueryResponse
CompleteQueryResponse.CompletionResult
Resource that represents completion results.
Protobuf type google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult
CompleteQueryResponse.CompletionResult.Builder
Resource that represents completion results.
Protobuf type google.cloud.retail.v2beta.CompleteQueryResponse.CompletionResult
CompleteQueryResponse.RecentSearchResult
Recent search of this user.
Protobuf type google.cloud.retail.v2beta.CompleteQueryResponse.RecentSearchResult
CompleteQueryResponse.RecentSearchResult.Builder
Recent search of this user.
Protobuf type google.cloud.retail.v2beta.CompleteQueryResponse.RecentSearchResult
CompletionConfig
Catalog level autocomplete config for customers to customize autocomplete feature's settings.
Protobuf type google.cloud.retail.v2beta.CompletionConfig
CompletionConfig.Builder
Catalog level autocomplete config for customers to customize autocomplete feature's settings.
Protobuf type google.cloud.retail.v2beta.CompletionConfig
CompletionConfigName
CompletionConfigName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig.
CompletionDataInputConfig
The input config source for completion data.
Protobuf type google.cloud.retail.v2beta.CompletionDataInputConfig
CompletionDataInputConfig.Builder
The input config source for completion data.
Protobuf type google.cloud.retail.v2beta.CompletionDataInputConfig
CompletionDetail
Detailed completion information including completion attribution token and clicked completion info.
Protobuf type google.cloud.retail.v2beta.CompletionDetail
CompletionDetail.Builder
Detailed completion information including completion attribution token and clicked completion info.
Protobuf type google.cloud.retail.v2beta.CompletionDetail
CompletionServiceClient
Service Description: Auto-completion service for retail.
This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
CompleteQueryRequest request =
CompleteQueryRequest.newBuilder()
.setCatalog(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
.setQuery("query107944136")
.setVisitorId("visitorId1880545833")
.addAllLanguageCodes(new ArrayList<String>())
.setDeviceType("deviceType781190832")
.setDataset("dataset1443214456")
.setMaxSuggestions(618824852)
.build();
CompleteQueryResponse response = completionServiceClient.completeQuery(request);
}
Note: close() needs to be called on the CompletionServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of CompletionServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CompletionServiceSettings completionServiceSettings =
CompletionServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CompletionServiceClient completionServiceClient =
CompletionServiceClient.create(completionServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CompletionServiceSettings completionServiceSettings =
CompletionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
CompletionServiceClient completionServiceClient =
CompletionServiceClient.create(completionServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CompletionServiceSettings completionServiceSettings =
CompletionServiceSettings.newBuilder()
.setTransportChannelProvider(
CompletionServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
CompletionServiceClient completionServiceClient =
CompletionServiceClient.create(completionServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
CompletionServiceGrpc
Auto-completion service for retail. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
CompletionServiceGrpc.CompletionServiceBlockingStub
Auto-completion service for retail. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
CompletionServiceGrpc.CompletionServiceFutureStub
Auto-completion service for retail. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
CompletionServiceGrpc.CompletionServiceImplBase
Auto-completion service for retail. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
CompletionServiceGrpc.CompletionServiceStub
Auto-completion service for retail. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
CompletionServiceProto
CompletionServiceSettings
Settings class to configure an instance of CompletionServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of completeQuery to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
CompletionServiceSettings.Builder completionServiceSettingsBuilder =
CompletionServiceSettings.newBuilder();
completionServiceSettingsBuilder
.completeQuerySettings()
.setRetrySettings(
completionServiceSettingsBuilder.completeQuerySettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CompletionServiceSettings completionServiceSettings = completionServiceSettingsBuilder.build();
CompletionServiceSettings.Builder
Builder for CompletionServiceSettings.
Condition
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
Protobuf type google.cloud.retail.v2beta.Condition
Condition.Builder
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
Protobuf type google.cloud.retail.v2beta.Condition
Condition.QueryTerm
Query terms that we want to match on.
Protobuf type google.cloud.retail.v2beta.Condition.QueryTerm
Condition.QueryTerm.Builder
Query terms that we want to match on.
Protobuf type google.cloud.retail.v2beta.Condition.QueryTerm
Condition.TimeRange
Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
Protobuf type google.cloud.retail.v2beta.Condition.TimeRange
Condition.TimeRange.Builder
Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
Protobuf type google.cloud.retail.v2beta.Condition.TimeRange
Control
Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
Protobuf type google.cloud.retail.v2beta.Control
Control.Builder
Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
Protobuf type google.cloud.retail.v2beta.Control
ControlName
ControlName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/controls/{control}.
ControlProto
ControlServiceClient
Service Description: Service for modifying Control.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
Control control = Control.newBuilder().build();
String controlId = "controlId-395080872";
Control response = controlServiceClient.createControl(parent, control, controlId);
}
Note: close() needs to be called on the ControlServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ControlServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ControlServiceSettings controlServiceSettings =
ControlServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ControlServiceClient controlServiceClient = ControlServiceClient.create(controlServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ControlServiceSettings controlServiceSettings =
ControlServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ControlServiceClient controlServiceClient = ControlServiceClient.create(controlServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ControlServiceSettings controlServiceSettings =
ControlServiceSettings.newBuilder()
.setTransportChannelProvider(
ControlServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ControlServiceClient controlServiceClient = ControlServiceClient.create(controlServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ControlServiceClient.ListControlsFixedSizeCollection
ControlServiceClient.ListControlsPage
ControlServiceClient.ListControlsPagedResponse
ControlServiceGrpc
Service for modifying Control.
ControlServiceGrpc.ControlServiceBlockingStub
Service for modifying Control.
ControlServiceGrpc.ControlServiceFutureStub
Service for modifying Control.
ControlServiceGrpc.ControlServiceImplBase
Service for modifying Control.
ControlServiceGrpc.ControlServiceStub
Service for modifying Control.
ControlServiceProto
ControlServiceSettings
Settings class to configure an instance of ControlServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createControl to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ControlServiceSettings.Builder controlServiceSettingsBuilder =
ControlServiceSettings.newBuilder();
controlServiceSettingsBuilder
.createControlSettings()
.setRetrySettings(
controlServiceSettingsBuilder.createControlSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ControlServiceSettings controlServiceSettings = controlServiceSettingsBuilder.build();
ControlServiceSettings.Builder
Builder for ControlServiceSettings.
CreateControlRequest
Request for CreateControl method.
Protobuf type google.cloud.retail.v2beta.CreateControlRequest
CreateControlRequest.Builder
Request for CreateControl method.
Protobuf type google.cloud.retail.v2beta.CreateControlRequest
CreateModelMetadata
Metadata associated with a create operation.
Protobuf type google.cloud.retail.v2beta.CreateModelMetadata
CreateModelMetadata.Builder
Metadata associated with a create operation.
Protobuf type google.cloud.retail.v2beta.CreateModelMetadata
CreateModelRequest
Request for creating a model.
Protobuf type google.cloud.retail.v2beta.CreateModelRequest
CreateModelRequest.Builder
Request for creating a model.
Protobuf type google.cloud.retail.v2beta.CreateModelRequest
CreateProductRequest
Request message for ProductService.CreateProduct method.
Protobuf type google.cloud.retail.v2beta.CreateProductRequest
CreateProductRequest.Builder
Request message for ProductService.CreateProduct method.
Protobuf type google.cloud.retail.v2beta.CreateProductRequest
CreateServingConfigRequest
Request for CreateServingConfig method.
Protobuf type google.cloud.retail.v2beta.CreateServingConfigRequest
CreateServingConfigRequest.Builder
Request for CreateServingConfig method.
Protobuf type google.cloud.retail.v2beta.CreateServingConfigRequest
CustomAttribute
A custom attribute that is not explicitly modeled in Product.
Protobuf type google.cloud.retail.v2beta.CustomAttribute
CustomAttribute.Builder
A custom attribute that is not explicitly modeled in Product.
Protobuf type google.cloud.retail.v2beta.CustomAttribute
DeleteControlRequest
Request for DeleteControl method.
Protobuf type google.cloud.retail.v2beta.DeleteControlRequest
DeleteControlRequest.Builder
Request for DeleteControl method.
Protobuf type google.cloud.retail.v2beta.DeleteControlRequest
DeleteModelRequest
Request for deleting a model.
Protobuf type google.cloud.retail.v2beta.DeleteModelRequest
DeleteModelRequest.Builder
Request for deleting a model.
Protobuf type google.cloud.retail.v2beta.DeleteModelRequest
DeleteProductRequest
Request message for ProductService.DeleteProduct method.
Protobuf type google.cloud.retail.v2beta.DeleteProductRequest
DeleteProductRequest.Builder
Request message for ProductService.DeleteProduct method.
Protobuf type google.cloud.retail.v2beta.DeleteProductRequest
DeleteServingConfigRequest
Request for DeleteServingConfig method.
Protobuf type google.cloud.retail.v2beta.DeleteServingConfigRequest
DeleteServingConfigRequest.Builder
Request for DeleteServingConfig method.
Protobuf type google.cloud.retail.v2beta.DeleteServingConfigRequest
ExportConfigProto
ExportErrorsConfig
Configuration of destination for Export related errors.
Protobuf type google.cloud.retail.v2beta.ExportErrorsConfig
ExportErrorsConfig.Builder
Configuration of destination for Export related errors.
Protobuf type google.cloud.retail.v2beta.ExportErrorsConfig
ExportMetadata
Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.
Protobuf type google.cloud.retail.v2beta.ExportMetadata
ExportMetadata.Builder
Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.
Protobuf type google.cloud.retail.v2beta.ExportMetadata
ExportProductsResponse
Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ExportProductsResponse
ExportProductsResponse.Builder
Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ExportProductsResponse
ExportUserEventsResponse
Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ExportUserEventsResponse
ExportUserEventsResponse.Builder
Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ExportUserEventsResponse
FulfillmentInfo
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
Protobuf type google.cloud.retail.v2beta.FulfillmentInfo
FulfillmentInfo.Builder
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
Protobuf type google.cloud.retail.v2beta.FulfillmentInfo
GcsSource
Google Cloud Storage location for input content.
Protobuf type google.cloud.retail.v2beta.GcsSource
GcsSource.Builder
Google Cloud Storage location for input content.
Protobuf type google.cloud.retail.v2beta.GcsSource
GetAttributesConfigRequest
Request for CatalogService.GetAttributesConfig method.
Protobuf type google.cloud.retail.v2beta.GetAttributesConfigRequest
GetAttributesConfigRequest.Builder
Request for CatalogService.GetAttributesConfig method.
Protobuf type google.cloud.retail.v2beta.GetAttributesConfigRequest
GetCompletionConfigRequest
Request for CatalogService.GetCompletionConfig method.
Protobuf type google.cloud.retail.v2beta.GetCompletionConfigRequest
GetCompletionConfigRequest.Builder
Request for CatalogService.GetCompletionConfig method.
Protobuf type google.cloud.retail.v2beta.GetCompletionConfigRequest
GetControlRequest
Request for GetControl method.
Protobuf type google.cloud.retail.v2beta.GetControlRequest
GetControlRequest.Builder
Request for GetControl method.
Protobuf type google.cloud.retail.v2beta.GetControlRequest
GetDefaultBranchRequest
Request message to show which branch is currently the default branch.
Protobuf type google.cloud.retail.v2beta.GetDefaultBranchRequest
GetDefaultBranchRequest.Builder
Request message to show which branch is currently the default branch.
Protobuf type google.cloud.retail.v2beta.GetDefaultBranchRequest
GetDefaultBranchResponse
Response message of CatalogService.GetDefaultBranch.
Protobuf type google.cloud.retail.v2beta.GetDefaultBranchResponse
GetDefaultBranchResponse.Builder
Response message of CatalogService.GetDefaultBranch.
Protobuf type google.cloud.retail.v2beta.GetDefaultBranchResponse
GetProductRequest
Request message for ProductService.GetProduct method.
Protobuf type google.cloud.retail.v2beta.GetProductRequest
GetProductRequest.Builder
Request message for ProductService.GetProduct method.
Protobuf type google.cloud.retail.v2beta.GetProductRequest
GetServingConfigRequest
Request for GetServingConfig method.
Protobuf type google.cloud.retail.v2beta.GetServingConfigRequest
GetServingConfigRequest.Builder
Request for GetServingConfig method.
Protobuf type google.cloud.retail.v2beta.GetServingConfigRequest
Image
Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
Protobuf type google.cloud.retail.v2beta.Image
Image.Builder
Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
Protobuf type google.cloud.retail.v2beta.Image
ImportCompletionDataRequest
Request message for ImportCompletionData methods.
Protobuf type google.cloud.retail.v2beta.ImportCompletionDataRequest
ImportCompletionDataRequest.Builder
Request message for ImportCompletionData methods.
Protobuf type google.cloud.retail.v2beta.ImportCompletionDataRequest
ImportCompletionDataResponse
Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
Protobuf type google.cloud.retail.v2beta.ImportCompletionDataResponse
ImportCompletionDataResponse.Builder
Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
Protobuf type google.cloud.retail.v2beta.ImportCompletionDataResponse
ImportConfigProto
ImportErrorsConfig
Configuration of destination for Import related errors.
Protobuf type google.cloud.retail.v2beta.ImportErrorsConfig
ImportErrorsConfig.Builder
Configuration of destination for Import related errors.
Protobuf type google.cloud.retail.v2beta.ImportErrorsConfig
ImportMetadata
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
Protobuf type google.cloud.retail.v2beta.ImportMetadata
ImportMetadata.Builder
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
Protobuf type google.cloud.retail.v2beta.ImportMetadata
ImportProductsRequest
Request message for Import methods.
Protobuf type google.cloud.retail.v2beta.ImportProductsRequest
ImportProductsRequest.Builder
Request message for Import methods.
Protobuf type google.cloud.retail.v2beta.ImportProductsRequest
ImportProductsResponse
Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ImportProductsResponse
ImportProductsResponse.Builder
Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ImportProductsResponse
ImportUserEventsRequest
Request message for the ImportUserEvents request.
Protobuf type google.cloud.retail.v2beta.ImportUserEventsRequest
ImportUserEventsRequest.Builder
Request message for the ImportUserEvents request.
Protobuf type google.cloud.retail.v2beta.ImportUserEventsRequest
ImportUserEventsResponse
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ImportUserEventsResponse
ImportUserEventsResponse.Builder
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Protobuf type google.cloud.retail.v2beta.ImportUserEventsResponse
Interval
A floating point interval.
Protobuf type google.cloud.retail.v2beta.Interval
Interval.Builder
A floating point interval.
Protobuf type google.cloud.retail.v2beta.Interval
ListCatalogsRequest
Request for CatalogService.ListCatalogs method.
Protobuf type google.cloud.retail.v2beta.ListCatalogsRequest
ListCatalogsRequest.Builder
Request for CatalogService.ListCatalogs method.
Protobuf type google.cloud.retail.v2beta.ListCatalogsRequest
ListCatalogsResponse
Response for CatalogService.ListCatalogs method.
Protobuf type google.cloud.retail.v2beta.ListCatalogsResponse
ListCatalogsResponse.Builder
Response for CatalogService.ListCatalogs method.
Protobuf type google.cloud.retail.v2beta.ListCatalogsResponse
ListControlsRequest
Request for ListControls method.
Protobuf type google.cloud.retail.v2beta.ListControlsRequest
ListControlsRequest.Builder
Request for ListControls method.
Protobuf type google.cloud.retail.v2beta.ListControlsRequest
ListControlsResponse
Response for ListControls method.
Protobuf type google.cloud.retail.v2beta.ListControlsResponse
ListControlsResponse.Builder
Response for ListControls method.
Protobuf type google.cloud.retail.v2beta.ListControlsResponse
ListModelsRequest
Request for listing models associated with a resource.
Protobuf type google.cloud.retail.v2beta.ListModelsRequest
ListModelsRequest.Builder
Request for listing models associated with a resource.
Protobuf type google.cloud.retail.v2beta.ListModelsRequest
ListModelsResponse
Response to a ListModelRequest.
Protobuf type google.cloud.retail.v2beta.ListModelsResponse
ListModelsResponse.Builder
Response to a ListModelRequest.
Protobuf type google.cloud.retail.v2beta.ListModelsResponse
ListProductsRequest
Request message for ProductService.ListProducts method.
Protobuf type google.cloud.retail.v2beta.ListProductsRequest
ListProductsRequest.Builder
Request message for ProductService.ListProducts method.
Protobuf type google.cloud.retail.v2beta.ListProductsRequest
ListProductsResponse
Response message for ProductService.ListProducts method.
Protobuf type google.cloud.retail.v2beta.ListProductsResponse
ListProductsResponse.Builder
Response message for ProductService.ListProducts method.
Protobuf type google.cloud.retail.v2beta.ListProductsResponse
ListServingConfigsRequest
Request for ListServingConfigs method.
Protobuf type google.cloud.retail.v2beta.ListServingConfigsRequest
ListServingConfigsRequest.Builder
Request for ListServingConfigs method.
Protobuf type google.cloud.retail.v2beta.ListServingConfigsRequest
ListServingConfigsResponse
Response for ListServingConfigs method.
Protobuf type google.cloud.retail.v2beta.ListServingConfigsResponse
ListServingConfigsResponse.Builder
Response for ListServingConfigs method.
Protobuf type google.cloud.retail.v2beta.ListServingConfigsResponse
LocalInventory
The inventory information at a place (e.g. a store) identified by a place ID.
Protobuf type google.cloud.retail.v2beta.LocalInventory
LocalInventory.Builder
The inventory information at a place (e.g. a store) identified by a place ID.
Protobuf type google.cloud.retail.v2beta.LocalInventory
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
MerchantCenterLink
Represents a link between a Merchant Center account and a branch. Once a link is established, products from the linked merchant center account will be streamed to the linked branch.
Protobuf type google.cloud.retail.v2beta.MerchantCenterLink
MerchantCenterLink.Builder
Represents a link between a Merchant Center account and a branch. Once a link is established, products from the linked merchant center account will be streamed to the linked branch.
Protobuf type google.cloud.retail.v2beta.MerchantCenterLink
MerchantCenterLinkingConfig
Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch.
Protobuf type google.cloud.retail.v2beta.MerchantCenterLinkingConfig
MerchantCenterLinkingConfig.Builder
Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch.
Protobuf type google.cloud.retail.v2beta.MerchantCenterLinkingConfig
Model
Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.
Protobuf type google.cloud.retail.v2beta.Model
Model.Builder
Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.
Protobuf type google.cloud.retail.v2beta.Model
Model.ServingConfigList
Represents an ordered combination of valid serving configs, which
can be used for PAGE_OPTIMIZATION
recommendations.
Protobuf type google.cloud.retail.v2beta.Model.ServingConfigList
Model.ServingConfigList.Builder
Represents an ordered combination of valid serving configs, which
can be used for PAGE_OPTIMIZATION
recommendations.
Protobuf type google.cloud.retail.v2beta.Model.ServingConfigList
ModelName
ModelName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/models/{model}.
ModelProto
ModelServiceClient
Service Description: Service for performing CRUD operations on models. Recommendation models
contain all the metadata necessary to generate a set of models for the Predict()
API. A model
is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g.
Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ModelServiceClient modelServiceClient = ModelServiceClient.create()) {
ModelName name = ModelName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[MODEL]");
Model response = modelServiceClient.pauseModel(name);
}
Note: close() needs to be called on the ModelServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ModelServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ModelServiceSettings modelServiceSettings =
ModelServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ModelServiceSettings modelServiceSettings =
ModelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ModelServiceSettings modelServiceSettings =
ModelServiceSettings.newBuilder()
.setTransportChannelProvider(
ModelServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ModelServiceClient modelServiceClient = ModelServiceClient.create(modelServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ModelServiceClient.ListModelsFixedSizeCollection
ModelServiceClient.ListModelsPage
ModelServiceClient.ListModelsPagedResponse
ModelServiceGrpc
Service for performing CRUD operations on models.
Recommendation models contain all the metadata necessary to generate a set of
models for the Predict()
API. A model is queried
indirectly via a ServingConfig, which associates a model with a
given Placement (e.g. Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
ModelServiceGrpc.ModelServiceBlockingStub
Service for performing CRUD operations on models.
Recommendation models contain all the metadata necessary to generate a set of
models for the Predict()
API. A model is queried
indirectly via a ServingConfig, which associates a model with a
given Placement (e.g. Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
ModelServiceGrpc.ModelServiceFutureStub
Service for performing CRUD operations on models.
Recommendation models contain all the metadata necessary to generate a set of
models for the Predict()
API. A model is queried
indirectly via a ServingConfig, which associates a model with a
given Placement (e.g. Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
ModelServiceGrpc.ModelServiceImplBase
Service for performing CRUD operations on models.
Recommendation models contain all the metadata necessary to generate a set of
models for the Predict()
API. A model is queried
indirectly via a ServingConfig, which associates a model with a
given Placement (e.g. Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
ModelServiceGrpc.ModelServiceStub
Service for performing CRUD operations on models.
Recommendation models contain all the metadata necessary to generate a set of
models for the Predict()
API. A model is queried
indirectly via a ServingConfig, which associates a model with a
given Placement (e.g. Frequently Bought Together on Home Page).
This service allows you to do the following:
- Initiate training of a model.
- Pause training of an existing model.
- List all the available models along with their metadata.
- Control their tuning schedule.
ModelServiceProto
ModelServiceSettings
Settings class to configure an instance of ModelServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of pauseModel to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ModelServiceSettings.Builder modelServiceSettingsBuilder = ModelServiceSettings.newBuilder();
modelServiceSettingsBuilder
.pauseModelSettings()
.setRetrySettings(
modelServiceSettingsBuilder.pauseModelSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ModelServiceSettings modelServiceSettings = modelServiceSettingsBuilder.build();
ModelServiceSettings.Builder
Builder for ModelServiceSettings.
OutputResult
Output result.
Protobuf type google.cloud.retail.v2beta.OutputResult
OutputResult.Builder
Output result.
Protobuf type google.cloud.retail.v2beta.OutputResult
PauseModelRequest
Request for pausing training of a model.
Protobuf type google.cloud.retail.v2beta.PauseModelRequest
PauseModelRequest.Builder
Request for pausing training of a model.
Protobuf type google.cloud.retail.v2beta.PauseModelRequest
PredictRequest
Request message for Predict method.
Protobuf type google.cloud.retail.v2beta.PredictRequest
PredictRequest.Builder
Request message for Predict method.
Protobuf type google.cloud.retail.v2beta.PredictRequest
PredictResponse
Response message for predict method.
Protobuf type google.cloud.retail.v2beta.PredictResponse
PredictResponse.Builder
Response message for predict method.
Protobuf type google.cloud.retail.v2beta.PredictResponse
PredictResponse.PredictionResult
PredictionResult represents the recommendation prediction results.
Protobuf type google.cloud.retail.v2beta.PredictResponse.PredictionResult
PredictResponse.PredictionResult.Builder
PredictionResult represents the recommendation prediction results.
Protobuf type google.cloud.retail.v2beta.PredictResponse.PredictionResult
PredictionServiceClient
Service Description: Service for making recommendation prediction.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
PredictRequest request =
PredictRequest.newBuilder()
.setPlacement("placement1792938725")
.setUserEvent(UserEvent.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setValidateOnly(true)
.putAllParams(new HashMap<String, Value>())
.putAllLabels(new HashMap<String, String>())
.build();
PredictResponse response = predictionServiceClient.predict(request);
}
Note: close() needs to be called on the PredictionServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of PredictionServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
PredictionServiceSettings predictionServiceSettings =
PredictionServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
PredictionServiceClient predictionServiceClient =
PredictionServiceClient.create(predictionServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
PredictionServiceSettings predictionServiceSettings =
PredictionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
PredictionServiceClient predictionServiceClient =
PredictionServiceClient.create(predictionServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
PredictionServiceSettings predictionServiceSettings =
PredictionServiceSettings.newBuilder()
.setTransportChannelProvider(
PredictionServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
PredictionServiceClient predictionServiceClient =
PredictionServiceClient.create(predictionServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
PredictionServiceGrpc
Service for making recommendation prediction.
PredictionServiceGrpc.PredictionServiceBlockingStub
Service for making recommendation prediction.
PredictionServiceGrpc.PredictionServiceFutureStub
Service for making recommendation prediction.
PredictionServiceGrpc.PredictionServiceImplBase
Service for making recommendation prediction.
PredictionServiceGrpc.PredictionServiceStub
Service for making recommendation prediction.
PredictionServiceProto
PredictionServiceSettings
Settings class to configure an instance of PredictionServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of predict to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
PredictionServiceSettings.Builder predictionServiceSettingsBuilder =
PredictionServiceSettings.newBuilder();
predictionServiceSettingsBuilder
.predictSettings()
.setRetrySettings(
predictionServiceSettingsBuilder.predictSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
PredictionServiceSettings predictionServiceSettings = predictionServiceSettingsBuilder.build();
PredictionServiceSettings.Builder
Builder for PredictionServiceSettings.
PriceInfo
The price information of a Product.
Protobuf type google.cloud.retail.v2beta.PriceInfo
PriceInfo.Builder
The price information of a Product.
Protobuf type google.cloud.retail.v2beta.PriceInfo
PriceInfo.PriceRange
The price range of all variant Product having the same Product.primary_product_id.
Protobuf type google.cloud.retail.v2beta.PriceInfo.PriceRange
PriceInfo.PriceRange.Builder
The price range of all variant Product having the same Product.primary_product_id.
Protobuf type google.cloud.retail.v2beta.PriceInfo.PriceRange
Product
Product captures all metadata information of items to be recommended or searched.
Protobuf type google.cloud.retail.v2beta.Product
Product.Builder
Product captures all metadata information of items to be recommended or searched.
Protobuf type google.cloud.retail.v2beta.Product
ProductDetail
Detailed product information associated with a user event.
Protobuf type google.cloud.retail.v2beta.ProductDetail
ProductDetail.Builder
Detailed product information associated with a user event.
Protobuf type google.cloud.retail.v2beta.ProductDetail
ProductInlineSource
The inline source for the input config for ImportProducts method.
Protobuf type google.cloud.retail.v2beta.ProductInlineSource
ProductInlineSource.Builder
The inline source for the input config for ImportProducts method.
Protobuf type google.cloud.retail.v2beta.ProductInlineSource
ProductInputConfig
The input config source for products.
Protobuf type google.cloud.retail.v2beta.ProductInputConfig
ProductInputConfig.Builder
The input config source for products.
Protobuf type google.cloud.retail.v2beta.ProductInputConfig
ProductLevelConfig
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
Protobuf type google.cloud.retail.v2beta.ProductLevelConfig
ProductLevelConfig.Builder
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
Protobuf type google.cloud.retail.v2beta.ProductLevelConfig
ProductName
ProductName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}.
ProductProto
ProductServiceClient
Service Description: Service for ingesting Product information of the customer's website.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ProductServiceClient productServiceClient = ProductServiceClient.create()) {
BranchName parent = BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]");
Product product = Product.newBuilder().build();
String productId = "productId-1051830678";
Product response = productServiceClient.createProduct(parent, product, productId);
}
Note: close() needs to be called on the ProductServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ProductServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ProductServiceSettings productServiceSettings =
ProductServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ProductServiceClient productServiceClient = ProductServiceClient.create(productServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ProductServiceSettings productServiceSettings =
ProductServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ProductServiceClient productServiceClient = ProductServiceClient.create(productServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ProductServiceSettings productServiceSettings =
ProductServiceSettings.newBuilder()
.setTransportChannelProvider(
ProductServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ProductServiceClient productServiceClient = ProductServiceClient.create(productServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ProductServiceClient.ListProductsFixedSizeCollection
ProductServiceClient.ListProductsPage
ProductServiceClient.ListProductsPagedResponse
ProductServiceGrpc
Service for ingesting Product information of the customer's website.
ProductServiceGrpc.ProductServiceBlockingStub
Service for ingesting Product information of the customer's website.
ProductServiceGrpc.ProductServiceFutureStub
Service for ingesting Product information of the customer's website.
ProductServiceGrpc.ProductServiceImplBase
Service for ingesting Product information of the customer's website.
ProductServiceGrpc.ProductServiceStub
Service for ingesting Product information of the customer's website.
ProductServiceProto
ProductServiceSettings
Settings class to configure an instance of ProductServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createProduct to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ProductServiceSettings.Builder productServiceSettingsBuilder =
ProductServiceSettings.newBuilder();
productServiceSettingsBuilder
.createProductSettings()
.setRetrySettings(
productServiceSettingsBuilder.createProductSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ProductServiceSettings productServiceSettings = productServiceSettingsBuilder.build();
ProductServiceSettings.Builder
Builder for ProductServiceSettings.
Promotion
Promotion information.
Protobuf type google.cloud.retail.v2beta.Promotion
Promotion.Builder
Promotion information.
Protobuf type google.cloud.retail.v2beta.Promotion
PromotionProto
PurchaseTransaction
A transaction represents the entire purchase transaction.
Protobuf type google.cloud.retail.v2beta.PurchaseTransaction
PurchaseTransaction.Builder
A transaction represents the entire purchase transaction.
Protobuf type google.cloud.retail.v2beta.PurchaseTransaction
PurgeConfigProto
PurgeMetadata
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Protobuf type google.cloud.retail.v2beta.PurgeMetadata
PurgeMetadata.Builder
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Protobuf type google.cloud.retail.v2beta.PurgeMetadata
PurgeUserEventsRequest
Request message for PurgeUserEvents method.
Protobuf type google.cloud.retail.v2beta.PurgeUserEventsRequest
PurgeUserEventsRequest.Builder
Request message for PurgeUserEvents method.
Protobuf type google.cloud.retail.v2beta.PurgeUserEventsRequest
PurgeUserEventsResponse
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Protobuf type google.cloud.retail.v2beta.PurgeUserEventsResponse
PurgeUserEventsResponse.Builder
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Protobuf type google.cloud.retail.v2beta.PurgeUserEventsResponse
Rating
The rating of a Product.
Protobuf type google.cloud.retail.v2beta.Rating
Rating.Builder
The rating of a Product.
Protobuf type google.cloud.retail.v2beta.Rating
RejoinUserEventsMetadata
Metadata for RejoinUserEvents
method.
Protobuf type google.cloud.retail.v2beta.RejoinUserEventsMetadata
RejoinUserEventsMetadata.Builder
Metadata for RejoinUserEvents
method.
Protobuf type google.cloud.retail.v2beta.RejoinUserEventsMetadata
RejoinUserEventsRequest
Request message for RejoinUserEvents method.
Protobuf type google.cloud.retail.v2beta.RejoinUserEventsRequest
RejoinUserEventsRequest.Builder
Request message for RejoinUserEvents method.
Protobuf type google.cloud.retail.v2beta.RejoinUserEventsRequest
RejoinUserEventsResponse
Response message for RejoinUserEvents
method.
Protobuf type google.cloud.retail.v2beta.RejoinUserEventsResponse
RejoinUserEventsResponse.Builder
Response message for RejoinUserEvents
method.
Protobuf type google.cloud.retail.v2beta.RejoinUserEventsResponse
RemoveCatalogAttributeRequest
Request for CatalogService.RemoveCatalogAttribute method.
Protobuf type google.cloud.retail.v2beta.RemoveCatalogAttributeRequest
RemoveCatalogAttributeRequest.Builder
Request for CatalogService.RemoveCatalogAttribute method.
Protobuf type google.cloud.retail.v2beta.RemoveCatalogAttributeRequest
RemoveControlRequest
Request for RemoveControl method.
Protobuf type google.cloud.retail.v2beta.RemoveControlRequest
RemoveControlRequest.Builder
Request for RemoveControl method.
Protobuf type google.cloud.retail.v2beta.RemoveControlRequest
RemoveFulfillmentPlacesMetadata
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.RemoveFulfillmentPlacesMetadata
RemoveFulfillmentPlacesMetadata.Builder
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.RemoveFulfillmentPlacesMetadata
RemoveFulfillmentPlacesRequest
Request message for ProductService.RemoveFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest
RemoveFulfillmentPlacesRequest.Builder
Request message for ProductService.RemoveFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.RemoveFulfillmentPlacesRequest
RemoveFulfillmentPlacesResponse
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.RemoveFulfillmentPlacesResponse
RemoveFulfillmentPlacesResponse.Builder
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.
Protobuf type google.cloud.retail.v2beta.RemoveFulfillmentPlacesResponse
RemoveLocalInventoriesMetadata
Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.
Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesMetadata
RemoveLocalInventoriesMetadata.Builder
Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.
Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesMetadata
RemoveLocalInventoriesRequest
Request message for ProductService.RemoveLocalInventories method.
Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesRequest
RemoveLocalInventoriesRequest.Builder
Request message for ProductService.RemoveLocalInventories method.
Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesRequest
RemoveLocalInventoriesResponse
Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.
Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesResponse
RemoveLocalInventoriesResponse.Builder
Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.
Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesResponse
ReplaceCatalogAttributeRequest
Request for CatalogService.ReplaceCatalogAttribute method.
Protobuf type google.cloud.retail.v2beta.ReplaceCatalogAttributeRequest
ReplaceCatalogAttributeRequest.Builder
Request for CatalogService.ReplaceCatalogAttribute method.
Protobuf type google.cloud.retail.v2beta.ReplaceCatalogAttributeRequest
ResumeModelRequest
Request for resuming training of a model.
Protobuf type google.cloud.retail.v2beta.ResumeModelRequest
ResumeModelRequest.Builder
Request for resuming training of a model.
Protobuf type google.cloud.retail.v2beta.ResumeModelRequest
Rule
A rule is a condition-action pair
- A condition defines when a rule is to be triggered.
- An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
Protobuf type google.cloud.retail.v2beta.Rule
Rule.BoostAction
A boost action to apply to results matching condition specified above.
Protobuf type google.cloud.retail.v2beta.Rule.BoostAction
Rule.BoostAction.Builder
A boost action to apply to results matching condition specified above.
Protobuf type google.cloud.retail.v2beta.Rule.BoostAction
Rule.Builder
A rule is a condition-action pair
- A condition defines when a rule is to be triggered.
- An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
Protobuf type google.cloud.retail.v2beta.Rule
Rule.DoNotAssociateAction
Prevents query_term
from being associated with specified terms during
search.
Example: Don't associate "gShoe" and "cheap".
Protobuf type google.cloud.retail.v2beta.Rule.DoNotAssociateAction
Rule.DoNotAssociateAction.Builder
Prevents query_term
from being associated with specified terms during
search.
Example: Don't associate "gShoe" and "cheap".
Protobuf type google.cloud.retail.v2beta.Rule.DoNotAssociateAction
Rule.FilterAction
- Rule Condition:
- No Condition.query_terms provided is a global match.
- 1 or more Condition.query_terms provided are combined with OR operator.
- Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.
- Action Result: Filters the returned objects to be ONLY those that passed the filter.
Protobuf type google.cloud.retail.v2beta.Rule.FilterAction
Rule.FilterAction.Builder
- Rule Condition:
- No Condition.query_terms provided is a global match.
- 1 or more Condition.query_terms provided are combined with OR operator.
- Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict.
- Action Result: Filters the returned objects to be ONLY those that passed the filter.
Protobuf type google.cloud.retail.v2beta.Rule.FilterAction
Rule.IgnoreAction
Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
Protobuf type google.cloud.retail.v2beta.Rule.IgnoreAction
Rule.IgnoreAction.Builder
Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
Protobuf type google.cloud.retail.v2beta.Rule.IgnoreAction
Rule.OnewaySynonymsAction
Maps a set of terms to a set of synonyms.
Set of synonyms will be treated as synonyms of each query term only.
query_terms
will not be treated as synonyms of each other.
Example: "sneakers" will use a synonym of "shoes".
"shoes" will not use a synonym of "sneakers".
Protobuf type google.cloud.retail.v2beta.Rule.OnewaySynonymsAction
Rule.OnewaySynonymsAction.Builder
Maps a set of terms to a set of synonyms.
Set of synonyms will be treated as synonyms of each query term only.
query_terms
will not be treated as synonyms of each other.
Example: "sneakers" will use a synonym of "shoes".
"shoes" will not use a synonym of "sneakers".
Protobuf type google.cloud.retail.v2beta.Rule.OnewaySynonymsAction
Rule.RedirectAction
Redirects a shopper to a specific page.
- Rule Condition:
- Must specify Condition.query_terms.
- Action Input: Request Query
- Action Result: Redirects shopper to provided uri.
Protobuf type google.cloud.retail.v2beta.Rule.RedirectAction
Rule.RedirectAction.Builder
Redirects a shopper to a specific page.
- Rule Condition:
- Must specify Condition.query_terms.
- Action Input: Request Query
- Action Result: Redirects shopper to provided uri.
Protobuf type google.cloud.retail.v2beta.Rule.RedirectAction
Rule.ReplacementAction
Replaces a term in the query. Multiple replacement candidates can be
specified. All query_terms
will be replaced with the replacement term.
Example: Replace "gShoe" with "google shoe".
Protobuf type google.cloud.retail.v2beta.Rule.ReplacementAction
Rule.ReplacementAction.Builder
Replaces a term in the query. Multiple replacement candidates can be
specified. All query_terms
will be replaced with the replacement term.
Example: Replace "gShoe" with "google shoe".
Protobuf type google.cloud.retail.v2beta.Rule.ReplacementAction
Rule.TwowaySynonymsAction
Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes".
- "sneakers" will use a synonym of "shoes".
- "shoes" will use a synonym of "sneakers".
Protobuf type google.cloud.retail.v2beta.Rule.TwowaySynonymsAction
Rule.TwowaySynonymsAction.Builder
Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes".
- "sneakers" will use a synonym of "shoes".
- "shoes" will use a synonym of "sneakers".
Protobuf type google.cloud.retail.v2beta.Rule.TwowaySynonymsAction
SearchRequest
Request message for SearchService.Search method.
Protobuf type google.cloud.retail.v2beta.SearchRequest
SearchRequest.BoostSpec
Boost specification to boost certain items.
Protobuf type google.cloud.retail.v2beta.SearchRequest.BoostSpec
SearchRequest.BoostSpec.Builder
Boost specification to boost certain items.
Protobuf type google.cloud.retail.v2beta.SearchRequest.BoostSpec
SearchRequest.BoostSpec.ConditionBoostSpec
Boost applies to products which match a condition.
Protobuf type google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec
SearchRequest.BoostSpec.ConditionBoostSpec.Builder
Boost applies to products which match a condition.
Protobuf type google.cloud.retail.v2beta.SearchRequest.BoostSpec.ConditionBoostSpec
SearchRequest.Builder
Request message for SearchService.Search method.
Protobuf type google.cloud.retail.v2beta.SearchRequest
SearchRequest.DynamicFacetSpec
The specifications of dynamically generated facets.
Protobuf type google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec
SearchRequest.DynamicFacetSpec.Builder
The specifications of dynamically generated facets.
Protobuf type google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec
SearchRequest.FacetSpec
A facet specification to perform faceted search.
Protobuf type google.cloud.retail.v2beta.SearchRequest.FacetSpec
SearchRequest.FacetSpec.Builder
A facet specification to perform faceted search.
Protobuf type google.cloud.retail.v2beta.SearchRequest.FacetSpec
SearchRequest.FacetSpec.FacetKey
Specifies how a facet is computed.
Protobuf type google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey
SearchRequest.FacetSpec.FacetKey.Builder
Specifies how a facet is computed.
Protobuf type google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey
SearchRequest.PersonalizationSpec
The specification for personalization.
Protobuf type google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec
SearchRequest.PersonalizationSpec.Builder
The specification for personalization.
Protobuf type google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec
SearchRequest.QueryExpansionSpec
Specification to determine under which conditions query expansion should occur.
Protobuf type google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec
SearchRequest.QueryExpansionSpec.Builder
Specification to determine under which conditions query expansion should occur.
Protobuf type google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec
SearchRequest.SpellCorrectionSpec
The specification for query spell correction.
Protobuf type google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec
SearchRequest.SpellCorrectionSpec.Builder
The specification for query spell correction.
Protobuf type google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec
SearchResponse
Response message for SearchService.Search method.
Protobuf type google.cloud.retail.v2beta.SearchResponse
SearchResponse.Builder
Response message for SearchService.Search method.
Protobuf type google.cloud.retail.v2beta.SearchResponse
SearchResponse.Facet
A facet result.
Protobuf type google.cloud.retail.v2beta.SearchResponse.Facet
SearchResponse.Facet.Builder
A facet result.
Protobuf type google.cloud.retail.v2beta.SearchResponse.Facet
SearchResponse.Facet.FacetValue
A facet value which contains value names and their count.
Protobuf type google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue
SearchResponse.Facet.FacetValue.Builder
A facet value which contains value names and their count.
Protobuf type google.cloud.retail.v2beta.SearchResponse.Facet.FacetValue
SearchResponse.QueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
Protobuf type google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo
SearchResponse.QueryExpansionInfo.Builder
Information describing query expansion including whether expansion has occurred.
Protobuf type google.cloud.retail.v2beta.SearchResponse.QueryExpansionInfo
SearchResponse.SearchResult
Represents the search results.
Protobuf type google.cloud.retail.v2beta.SearchResponse.SearchResult
SearchResponse.SearchResult.Builder
Represents the search results.
Protobuf type google.cloud.retail.v2beta.SearchResponse.SearchResult
SearchServiceClient
Service Description: Service for search.
This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
SearchRequest request =
SearchRequest.newBuilder()
.setPlacement("placement1792938725")
.setBranch(
BranchName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[BRANCH]").toString())
.setQuery("query107944136")
.setVisitorId("visitorId1880545833")
.setUserInfo(UserInfo.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOffset(-1019779949)
.setFilter("filter-1274492040")
.setCanonicalFilter("canonicalFilter-722283124")
.setOrderBy("orderBy-1207110587")
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
.setDynamicFacetSpec(SearchRequest.DynamicFacetSpec.newBuilder().build())
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
.addAllVariantRollupKeys(new ArrayList<String>())
.addAllPageCategories(new ArrayList<String>())
.setPersonalizationSpec(SearchRequest.PersonalizationSpec.newBuilder().build())
.putAllLabels(new HashMap<String, String>())
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
.build();
for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
// doThingsWith(element);
}
}
Note: close() needs to be called on the SearchServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SearchServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
SearchServiceSettings searchServiceSettings =
SearchServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
SearchServiceSettings searchServiceSettings =
SearchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
SearchServiceSettings searchServiceSettings =
SearchServiceSettings.newBuilder()
.setTransportChannelProvider(
SearchServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
SearchServiceClient searchServiceClient = SearchServiceClient.create(searchServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
SearchServiceClient.SearchFixedSizeCollection
SearchServiceClient.SearchPage
SearchServiceClient.SearchPagedResponse
SearchServiceGrpc
Service for search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
SearchServiceGrpc.SearchServiceBlockingStub
Service for search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
SearchServiceGrpc.SearchServiceFutureStub
Service for search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
SearchServiceGrpc.SearchServiceImplBase
Service for search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
SearchServiceGrpc.SearchServiceStub
Service for search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
SearchServiceProto
SearchServiceSettings
Settings class to configure an instance of SearchServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of search to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
SearchServiceSettings.Builder searchServiceSettingsBuilder = SearchServiceSettings.newBuilder();
searchServiceSettingsBuilder
.searchSettings()
.setRetrySettings(
searchServiceSettingsBuilder.searchSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
SearchServiceSettings searchServiceSettings = searchServiceSettingsBuilder.build();
SearchServiceSettings.Builder
Builder for SearchServiceSettings.
ServingConfig
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).
Protobuf type google.cloud.retail.v2beta.ServingConfig
ServingConfig.Builder
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).
Protobuf type google.cloud.retail.v2beta.ServingConfig
ServingConfigName
ServingConfigName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}.
ServingConfigProto
ServingConfigServiceClient
Service Description: Service for modifying ServingConfig.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ServingConfigServiceClient servingConfigServiceClient =
ServingConfigServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
ServingConfig servingConfig = ServingConfig.newBuilder().build();
String servingConfigId = "servingConfigId-831052759";
ServingConfig response =
servingConfigServiceClient.createServingConfig(parent, servingConfig, servingConfigId);
}
Note: close() needs to be called on the ServingConfigServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ServingConfigServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ServingConfigServiceSettings servingConfigServiceSettings =
ServingConfigServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ServingConfigServiceClient servingConfigServiceClient =
ServingConfigServiceClient.create(servingConfigServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ServingConfigServiceSettings servingConfigServiceSettings =
ServingConfigServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
ServingConfigServiceClient servingConfigServiceClient =
ServingConfigServiceClient.create(servingConfigServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ServingConfigServiceSettings servingConfigServiceSettings =
ServingConfigServiceSettings.newBuilder()
.setTransportChannelProvider(
ServingConfigServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ServingConfigServiceClient servingConfigServiceClient =
ServingConfigServiceClient.create(servingConfigServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ServingConfigServiceClient.ListServingConfigsFixedSizeCollection
ServingConfigServiceClient.ListServingConfigsPage
ServingConfigServiceClient.ListServingConfigsPagedResponse
ServingConfigServiceGrpc
Service for modifying ServingConfig.
ServingConfigServiceGrpc.ServingConfigServiceBlockingStub
Service for modifying ServingConfig.
ServingConfigServiceGrpc.ServingConfigServiceFutureStub
Service for modifying ServingConfig.
ServingConfigServiceGrpc.ServingConfigServiceImplBase
Service for modifying ServingConfig.
ServingConfigServiceGrpc.ServingConfigServiceStub
Service for modifying ServingConfig.
ServingConfigServiceProto
ServingConfigServiceSettings
Settings class to configure an instance of ServingConfigServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createServingConfig to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ServingConfigServiceSettings.Builder servingConfigServiceSettingsBuilder =
ServingConfigServiceSettings.newBuilder();
servingConfigServiceSettingsBuilder
.createServingConfigSettings()
.setRetrySettings(
servingConfigServiceSettingsBuilder
.createServingConfigSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ServingConfigServiceSettings servingConfigServiceSettings =
servingConfigServiceSettingsBuilder.build();
ServingConfigServiceSettings.Builder
Builder for ServingConfigServiceSettings.
SetDefaultBranchRequest
Request message to set a specified branch as new default_branch.
Protobuf type google.cloud.retail.v2beta.SetDefaultBranchRequest
SetDefaultBranchRequest.Builder
Request message to set a specified branch as new default_branch.
Protobuf type google.cloud.retail.v2beta.SetDefaultBranchRequest
SetInventoryMetadata
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.
Protobuf type google.cloud.retail.v2beta.SetInventoryMetadata
SetInventoryMetadata.Builder
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.
Protobuf type google.cloud.retail.v2beta.SetInventoryMetadata
SetInventoryRequest
Request message for ProductService.SetInventory method.
Protobuf type google.cloud.retail.v2beta.SetInventoryRequest
SetInventoryRequest.Builder
Request message for ProductService.SetInventory method.
Protobuf type google.cloud.retail.v2beta.SetInventoryRequest
SetInventoryResponse
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.
Protobuf type google.cloud.retail.v2beta.SetInventoryResponse
SetInventoryResponse.Builder
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.
Protobuf type google.cloud.retail.v2beta.SetInventoryResponse
TuneModelMetadata
Metadata associated with a tune operation.
Protobuf type google.cloud.retail.v2beta.TuneModelMetadata
TuneModelMetadata.Builder
Metadata associated with a tune operation.
Protobuf type google.cloud.retail.v2beta.TuneModelMetadata
TuneModelRequest
Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
Protobuf type google.cloud.retail.v2beta.TuneModelRequest
TuneModelRequest.Builder
Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
Protobuf type google.cloud.retail.v2beta.TuneModelRequest
TuneModelResponse
Response associated with a tune operation.
Protobuf type google.cloud.retail.v2beta.TuneModelResponse
TuneModelResponse.Builder
Response associated with a tune operation.
Protobuf type google.cloud.retail.v2beta.TuneModelResponse
UpdateAttributesConfigRequest
Request for CatalogService.UpdateAttributesConfig method.
Protobuf type google.cloud.retail.v2beta.UpdateAttributesConfigRequest
UpdateAttributesConfigRequest.Builder
Request for CatalogService.UpdateAttributesConfig method.
Protobuf type google.cloud.retail.v2beta.UpdateAttributesConfigRequest
UpdateCatalogRequest
Request for CatalogService.UpdateCatalog method.
Protobuf type google.cloud.retail.v2beta.UpdateCatalogRequest
UpdateCatalogRequest.Builder
Request for CatalogService.UpdateCatalog method.
Protobuf type google.cloud.retail.v2beta.UpdateCatalogRequest
UpdateCompletionConfigRequest
Request for CatalogService.UpdateCompletionConfig method.
Protobuf type google.cloud.retail.v2beta.UpdateCompletionConfigRequest
UpdateCompletionConfigRequest.Builder
Request for CatalogService.UpdateCompletionConfig method.
Protobuf type google.cloud.retail.v2beta.UpdateCompletionConfigRequest
UpdateControlRequest
Request for UpdateControl method.
Protobuf type google.cloud.retail.v2beta.UpdateControlRequest
UpdateControlRequest.Builder
Request for UpdateControl method.
Protobuf type google.cloud.retail.v2beta.UpdateControlRequest
UpdateModelRequest
Request for updating an existing model.
Protobuf type google.cloud.retail.v2beta.UpdateModelRequest
UpdateModelRequest.Builder
Request for updating an existing model.
Protobuf type google.cloud.retail.v2beta.UpdateModelRequest
UpdateProductRequest
Request message for ProductService.UpdateProduct method.
Protobuf type google.cloud.retail.v2beta.UpdateProductRequest
UpdateProductRequest.Builder
Request message for ProductService.UpdateProduct method.
Protobuf type google.cloud.retail.v2beta.UpdateProductRequest
UpdateServingConfigRequest
Request for UpdateServingConfig method.
Protobuf type google.cloud.retail.v2beta.UpdateServingConfigRequest
UpdateServingConfigRequest.Builder
Request for UpdateServingConfig method.
Protobuf type google.cloud.retail.v2beta.UpdateServingConfigRequest
UserEvent
UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
Protobuf type google.cloud.retail.v2beta.UserEvent
UserEvent.Builder
UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
Protobuf type google.cloud.retail.v2beta.UserEvent
UserEventImportSummary
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
Protobuf type google.cloud.retail.v2beta.UserEventImportSummary
UserEventImportSummary.Builder
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
Protobuf type google.cloud.retail.v2beta.UserEventImportSummary
UserEventInlineSource
The inline source for the input config for ImportUserEvents method.
Protobuf type google.cloud.retail.v2beta.UserEventInlineSource
UserEventInlineSource.Builder
The inline source for the input config for ImportUserEvents method.
Protobuf type google.cloud.retail.v2beta.UserEventInlineSource
UserEventInputConfig
The input config source for user events.
Protobuf type google.cloud.retail.v2beta.UserEventInputConfig
UserEventInputConfig.Builder
The input config source for user events.
Protobuf type google.cloud.retail.v2beta.UserEventInputConfig
UserEventProto
UserEventServiceClient
Service Description: Service for ingesting end user actions on the customer website.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder()
.setParent("parent-995424086")
.setUserEvent(UserEvent.newBuilder().build())
.build();
UserEvent response = userEventServiceClient.writeUserEvent(request);
}
Note: close() needs to be called on the UserEventServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of UserEventServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
UserEventServiceSettings userEventServiceSettings =
UserEventServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
UserEventServiceClient userEventServiceClient =
UserEventServiceClient.create(userEventServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
UserEventServiceSettings userEventServiceSettings =
UserEventServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
UserEventServiceClient userEventServiceClient =
UserEventServiceClient.create(userEventServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
UserEventServiceSettings userEventServiceSettings =
UserEventServiceSettings.newBuilder()
.setTransportChannelProvider(
UserEventServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
UserEventServiceClient userEventServiceClient =
UserEventServiceClient.create(userEventServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
UserEventServiceGrpc
Service for ingesting end user actions on the customer website.
UserEventServiceGrpc.UserEventServiceBlockingStub
Service for ingesting end user actions on the customer website.
UserEventServiceGrpc.UserEventServiceFutureStub
Service for ingesting end user actions on the customer website.
UserEventServiceGrpc.UserEventServiceImplBase
Service for ingesting end user actions on the customer website.
UserEventServiceGrpc.UserEventServiceStub
Service for ingesting end user actions on the customer website.
UserEventServiceProto
UserEventServiceSettings
Settings class to configure an instance of UserEventServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (retail.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of writeUserEvent to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
UserEventServiceSettings.Builder userEventServiceSettingsBuilder =
UserEventServiceSettings.newBuilder();
userEventServiceSettingsBuilder
.writeUserEventSettings()
.setRetrySettings(
userEventServiceSettingsBuilder.writeUserEventSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
UserEventServiceSettings userEventServiceSettings = userEventServiceSettingsBuilder.build();
UserEventServiceSettings.Builder
Builder for UserEventServiceSettings.
UserInfo
Information of an end user.
Protobuf type google.cloud.retail.v2beta.UserInfo
UserInfo.Builder
Information of an end user.
Protobuf type google.cloud.retail.v2beta.UserInfo
WriteUserEventRequest
Request message for WriteUserEvent method.
Protobuf type google.cloud.retail.v2beta.WriteUserEventRequest
WriteUserEventRequest.Builder
Request message for WriteUserEvent method.
Protobuf type google.cloud.retail.v2beta.WriteUserEventRequest
Interfaces
AddCatalogAttributeRequestOrBuilder
AddControlRequestOrBuilder
AddFulfillmentPlacesMetadataOrBuilder
AddFulfillmentPlacesRequestOrBuilder
AddFulfillmentPlacesResponseOrBuilder
AddLocalInventoriesMetadataOrBuilder
AddLocalInventoriesRequestOrBuilder
AddLocalInventoriesResponseOrBuilder
AttributesConfigOrBuilder
AudienceOrBuilder
BatchRemoveCatalogAttributesRequestOrBuilder
BatchRemoveCatalogAttributesResponseOrBuilder
BigQueryOutputResultOrBuilder
BigQuerySourceOrBuilder
CatalogAttributeOrBuilder
CatalogOrBuilder
CollectUserEventRequestOrBuilder
ColorInfoOrBuilder
CompleteQueryRequestOrBuilder
CompleteQueryResponse.CompletionResultOrBuilder
CompleteQueryResponse.RecentSearchResultOrBuilder
CompleteQueryResponseOrBuilder
CompletionConfigOrBuilder
CompletionDataInputConfigOrBuilder
CompletionDetailOrBuilder
Condition.QueryTermOrBuilder
Condition.TimeRangeOrBuilder
ConditionOrBuilder
ControlOrBuilder
CreateControlRequestOrBuilder
CreateModelMetadataOrBuilder
CreateModelRequestOrBuilder
CreateProductRequestOrBuilder
CreateServingConfigRequestOrBuilder
CustomAttributeOrBuilder
DeleteControlRequestOrBuilder
DeleteModelRequestOrBuilder
DeleteProductRequestOrBuilder
DeleteServingConfigRequestOrBuilder
ExportErrorsConfigOrBuilder
ExportMetadataOrBuilder
ExportProductsResponseOrBuilder
ExportUserEventsResponseOrBuilder
FulfillmentInfoOrBuilder
GcsSourceOrBuilder
GetAttributesConfigRequestOrBuilder
GetCompletionConfigRequestOrBuilder
GetControlRequestOrBuilder
GetDefaultBranchRequestOrBuilder
GetDefaultBranchResponseOrBuilder
GetProductRequestOrBuilder
GetServingConfigRequestOrBuilder
ImageOrBuilder
ImportCompletionDataRequestOrBuilder
ImportCompletionDataResponseOrBuilder
ImportErrorsConfigOrBuilder
ImportMetadataOrBuilder
ImportProductsRequestOrBuilder
ImportProductsResponseOrBuilder
ImportUserEventsRequestOrBuilder
ImportUserEventsResponseOrBuilder
IntervalOrBuilder
ListCatalogsRequestOrBuilder
ListCatalogsResponseOrBuilder
ListControlsRequestOrBuilder
ListControlsResponseOrBuilder
ListModelsRequestOrBuilder
ListModelsResponseOrBuilder
ListProductsRequestOrBuilder
ListProductsResponseOrBuilder
ListServingConfigsRequestOrBuilder
ListServingConfigsResponseOrBuilder
LocalInventoryOrBuilder
MerchantCenterLinkOrBuilder
MerchantCenterLinkingConfigOrBuilder
Model.ServingConfigListOrBuilder
ModelOrBuilder
OutputResultOrBuilder
PauseModelRequestOrBuilder
PredictRequestOrBuilder
PredictResponse.PredictionResultOrBuilder
PredictResponseOrBuilder
PriceInfo.PriceRangeOrBuilder
PriceInfoOrBuilder
ProductDetailOrBuilder
ProductInlineSourceOrBuilder
ProductInputConfigOrBuilder
ProductLevelConfigOrBuilder
ProductOrBuilder
PromotionOrBuilder
PurchaseTransactionOrBuilder
PurgeMetadataOrBuilder
PurgeUserEventsRequestOrBuilder
PurgeUserEventsResponseOrBuilder
RatingOrBuilder
RejoinUserEventsMetadataOrBuilder
RejoinUserEventsRequestOrBuilder
RejoinUserEventsResponseOrBuilder
RemoveCatalogAttributeRequestOrBuilder
RemoveControlRequestOrBuilder
RemoveFulfillmentPlacesMetadataOrBuilder
RemoveFulfillmentPlacesRequestOrBuilder
RemoveFulfillmentPlacesResponseOrBuilder
RemoveLocalInventoriesMetadataOrBuilder
RemoveLocalInventoriesRequestOrBuilder
RemoveLocalInventoriesResponseOrBuilder
ReplaceCatalogAttributeRequestOrBuilder
ResumeModelRequestOrBuilder
Rule.BoostActionOrBuilder
Rule.DoNotAssociateActionOrBuilder
Rule.FilterActionOrBuilder
Rule.IgnoreActionOrBuilder
Rule.OnewaySynonymsActionOrBuilder
Rule.RedirectActionOrBuilder
Rule.ReplacementActionOrBuilder
Rule.TwowaySynonymsActionOrBuilder
RuleOrBuilder
SearchRequest.BoostSpec.ConditionBoostSpecOrBuilder
SearchRequest.BoostSpecOrBuilder
SearchRequest.DynamicFacetSpecOrBuilder
SearchRequest.FacetSpec.FacetKeyOrBuilder
SearchRequest.FacetSpecOrBuilder
SearchRequest.PersonalizationSpecOrBuilder
SearchRequest.QueryExpansionSpecOrBuilder
SearchRequest.SpellCorrectionSpecOrBuilder
SearchRequestOrBuilder
SearchResponse.Facet.FacetValueOrBuilder
SearchResponse.FacetOrBuilder
SearchResponse.QueryExpansionInfoOrBuilder
SearchResponse.SearchResultOrBuilder
SearchResponseOrBuilder
ServingConfigOrBuilder
SetDefaultBranchRequestOrBuilder
SetInventoryMetadataOrBuilder
SetInventoryRequestOrBuilder
SetInventoryResponseOrBuilder
TuneModelMetadataOrBuilder
TuneModelRequestOrBuilder
TuneModelResponseOrBuilder
UpdateAttributesConfigRequestOrBuilder
UpdateCatalogRequestOrBuilder
UpdateCompletionConfigRequestOrBuilder
UpdateControlRequestOrBuilder
UpdateModelRequestOrBuilder
UpdateProductRequestOrBuilder
UpdateServingConfigRequestOrBuilder
UserEventImportSummaryOrBuilder
UserEventInlineSourceOrBuilder
UserEventInputConfigOrBuilder
UserEventOrBuilder
UserInfoOrBuilder
WriteUserEventRequestOrBuilder
Enums
AttributeConfigLevel
At which level we offer configuration for attributes.
Protobuf enum google.cloud.retail.v2beta.AttributeConfigLevel
BigQuerySource.PartitionCase
CatalogAttribute.AttributeType
The type of an attribute.
Protobuf enum google.cloud.retail.v2beta.CatalogAttribute.AttributeType
CatalogAttribute.DynamicFacetableOption
The status of the dynamic facetable option of a catalog attribute.
Protobuf enum google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption
CatalogAttribute.ExactSearchableOption
The status of the exact-searchable option of a catalog attribute.
Protobuf enum google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption
CatalogAttribute.IndexableOption
The status of the indexable option of a catalog attribute.
Protobuf enum google.cloud.retail.v2beta.CatalogAttribute.IndexableOption
CatalogAttribute.SearchableOption
The status of the searchable option of a catalog attribute.
Protobuf enum google.cloud.retail.v2beta.CatalogAttribute.SearchableOption
CompletionDataInputConfig.SourceCase
Control.ControlCase
ExportErrorsConfig.DestinationCase
ImportErrorsConfig.DestinationCase
ImportProductsRequest.ReconciliationMode
Indicates how imported products are reconciled with the existing products created or imported before.
Protobuf enum google.cloud.retail.v2beta.ImportProductsRequest.ReconciliationMode
Interval.MaxCase
Interval.MinCase
Model.DataState
Describes whether this model have sufficient training data to be continuously trained.
Protobuf enum google.cloud.retail.v2beta.Model.DataState
Model.PeriodicTuningState
Describes whether periodic tuning is enabled for this model
or not. Periodic tuning is scheduled at most every three months. You can
start a tuning process manually by using the TuneModel
method, which starts a tuning process immediately and resets the quarterly
schedule. Enabling or disabling periodic tuning does not affect any
current tuning processes.
Protobuf enum google.cloud.retail.v2beta.Model.PeriodicTuningState
Model.ServingState
The serving state of the model.
Protobuf enum google.cloud.retail.v2beta.Model.ServingState
Model.TrainingState
The training state of the model.
Protobuf enum google.cloud.retail.v2beta.Model.TrainingState
Product.Availability
Product availability. If this field is unspecified, the product is assumed to be in stock.
Protobuf enum google.cloud.retail.v2beta.Product.Availability
Product.ExpirationCase
Product.Type
The type of this product.
Protobuf enum google.cloud.retail.v2beta.Product.Type
ProductInputConfig.SourceCase
RecommendationsFilteringOption
If filtering for recommendations is enabled.
Protobuf enum google.cloud.retail.v2beta.RecommendationsFilteringOption
RejoinUserEventsRequest.UserEventRejoinScope
The scope of user events to be rejoined with the latest product catalog.
If the rejoining aims at reducing number of unjoined events, set
UserEventRejoinScope
to UNJOINED_EVENTS
.
If the rejoining aims at correcting product catalog information in joined
events, set UserEventRejoinScope
to JOINED_EVENTS
.
If all events needs to be rejoined, set UserEventRejoinScope
to
USER_EVENT_REJOIN_SCOPE_UNSPECIFIED
.
Protobuf enum google.cloud.retail.v2beta.RejoinUserEventsRequest.UserEventRejoinScope
Rule.ActionCase
SearchRequest.DynamicFacetSpec.Mode
Enum to control DynamicFacet mode
Protobuf enum google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec.Mode
SearchRequest.PersonalizationSpec.Mode
The personalization mode of each search request.
Protobuf enum google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode
SearchRequest.QueryExpansionSpec.Condition
Enum describing under which condition query expansion should occur.
Protobuf enum google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec.Condition
SearchRequest.SearchMode
The search mode of each search request.
Protobuf enum google.cloud.retail.v2beta.SearchRequest.SearchMode
SearchRequest.SpellCorrectionSpec.Mode
Enum describing under which mode spell correction should occur.
Protobuf enum google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec.Mode
SearchResponse.Facet.FacetValue.FacetValueCase
SearchSolutionUseCase
The use case of Cloud Retail Search.
Protobuf enum google.cloud.retail.v2beta.SearchSolutionUseCase
ServingConfig.DiversityType
What type of diversity - data or rule based. If none is specified, default to rule based.
Protobuf enum google.cloud.retail.v2beta.ServingConfig.DiversityType
SolutionType
The type of solution.
Protobuf enum google.cloud.retail.v2beta.SolutionType