@Generated("by gapic-generator-java")
Package com.google.cloud.recommendationengine.v1beta1
The interfaces provided are listed below, along with usage samples.
======================= CatalogServiceClient =======================
Service Description: Service for ingesting catalog information of the customer's website.
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()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
CatalogItem catalogItem = CatalogItem.newBuilder().build();
CatalogItem response = catalogServiceClient.createCatalogItem(parent, catalogItem);
}
======================= PredictionApiKeyRegistryClient =======================
Service Description: Service for registering API keys for use with the `predict` method. If you use an API key to request predictions, you must first register the API key. Otherwise, your prediction request is rejected. If you use OAuth to authenticate your `predict` method call, you do not need to register an API key. You can register up to 20 API keys per project.
Sample for PredictionApiKeyRegistryClient:
// 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 (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
PredictionApiKeyRegistryClient.create()) {
EventStoreName parent =
EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
PredictionApiKeyRegistration predictionApiKeyRegistration =
PredictionApiKeyRegistration.newBuilder().build();
PredictionApiKeyRegistration response =
predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(
parent, predictionApiKeyRegistration);
}
======================= 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()) {
PlacementName name =
PlacementName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]", "[PLACEMENT]");
UserEvent userEvent = UserEvent.newBuilder().build();
for (Map.Entry<String, Value> element :
predictionServiceClient.predict(name, userEvent).iterateAll()) {
// doThingsWith(element);
}
}
======================= 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()) {
EventStoreName parent =
EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
UserEvent userEvent = UserEvent.newBuilder().build();
UserEvent response = userEventServiceClient.writeUserEvent(parent, userEvent);
}
-
Class Summary Class Description Catalog CatalogInlineSource The inline source for the input config for ImportCatalogItems method.CatalogInlineSource.Builder The inline source for the input config for ImportCatalogItems method.CatalogItem CatalogItem captures all metadata information of items to be recommended.CatalogItem.Builder CatalogItem captures all metadata information of items to be recommended.CatalogItem.CategoryHierarchy Category represents catalog item category hierarchy.CatalogItem.CategoryHierarchy.Builder Category represents catalog item category hierarchy.CatalogItemPathName CatalogItemPathName.Builder Builder for projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}.CatalogName CatalogName.Builder Builder for projects/{project}/locations/{location}/catalogs/{catalog}.CatalogServiceClient Service Description: Service for ingesting catalog information of the customer's website.CatalogServiceClient.ListCatalogItemsFixedSizeCollection CatalogServiceClient.ListCatalogItemsPage CatalogServiceClient.ListCatalogItemsPagedResponse CatalogServiceGrpc Service for ingesting catalog information of the customer's website.CatalogServiceGrpc.CatalogServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service CatalogService.CatalogServiceGrpc.CatalogServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service CatalogService.CatalogServiceGrpc.CatalogServiceImplBase Base class for the server implementation of the service CatalogService.CatalogServiceGrpc.CatalogServiceStub A stub to allow clients to do asynchronous rpc calls to service CatalogService.CatalogServiceOuterClass CatalogServiceSettings Settings class to configure an instance ofCatalogServiceClient
.CatalogServiceSettings.Builder Builder for CatalogServiceSettings.CollectUserEventRequest Request message for CollectUserEvent method.CollectUserEventRequest.Builder Request message for CollectUserEvent method.Common CreateCatalogItemRequest Request message for CreateCatalogItem method.CreateCatalogItemRequest.Builder Request message for CreateCatalogItem method.CreatePredictionApiKeyRegistrationRequest Request message for the `CreatePredictionApiKeyRegistration` method.CreatePredictionApiKeyRegistrationRequest.Builder Request message for the `CreatePredictionApiKeyRegistration` method.DeleteCatalogItemRequest Request message for DeleteCatalogItem method.DeleteCatalogItemRequest.Builder Request message for DeleteCatalogItem method.DeletePredictionApiKeyRegistrationRequest Request message for `DeletePredictionApiKeyRegistration` method.DeletePredictionApiKeyRegistrationRequest.Builder Request message for `DeletePredictionApiKeyRegistration` method.EventDetail User event details shared by all recommendation types.EventDetail.Builder User event details shared by all recommendation types.EventStoreName EventStoreName.Builder Builder for projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}.FeatureMap FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.FeatureMap.Builder FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.FeatureMap.FloatList A list of float features.FeatureMap.FloatList.Builder A list of float features.FeatureMap.StringList A list of string features.FeatureMap.StringList.Builder A list of string features.GcsSource Google Cloud Storage location for input content.GcsSource.Builder Google Cloud Storage location for input content.GetCatalogItemRequest Request message for GetCatalogItem method.GetCatalogItemRequest.Builder Request message for GetCatalogItem method.Image Catalog item thumbnail/detail image.Image.Builder Catalog item thumbnail/detail image.Import ImportCatalogItemsRequest Request message for Import methods.ImportCatalogItemsRequest.Builder Request message for Import methods.ImportCatalogItemsResponse Response of the ImportCatalogItemsRequest.ImportCatalogItemsResponse.Builder Response of the ImportCatalogItemsRequest.ImportErrorsConfig Configuration of destination for Import related errors.ImportErrorsConfig.Builder Configuration of destination for Import related errors.ImportMetadata Metadata related to the progress of the Import operation.ImportMetadata.Builder Metadata related to the progress of the Import operation.ImportUserEventsRequest Request message for the ImportUserEvents request.ImportUserEventsRequest.Builder Request message for the ImportUserEvents request.ImportUserEventsResponse Response of the ImportUserEventsRequest.ImportUserEventsResponse.Builder Response of the ImportUserEventsRequest.InputConfig The input config source.InputConfig.Builder The input config source.ListCatalogItemsRequest Request message for ListCatalogItems method.ListCatalogItemsRequest.Builder Request message for ListCatalogItems method.ListCatalogItemsResponse Response message for ListCatalogItems method.ListCatalogItemsResponse.Builder Response message for ListCatalogItems method.ListPredictionApiKeyRegistrationsRequest Request message for the `ListPredictionApiKeyRegistrations`.ListPredictionApiKeyRegistrationsRequest.Builder Request message for the `ListPredictionApiKeyRegistrations`.ListPredictionApiKeyRegistrationsResponse Response message for the `ListPredictionApiKeyRegistrations`.ListPredictionApiKeyRegistrationsResponse.Builder Response message for the `ListPredictionApiKeyRegistrations`.ListUserEventsRequest Request message for ListUserEvents method.ListUserEventsRequest.Builder Request message for ListUserEvents method.ListUserEventsResponse Response message for ListUserEvents method.ListUserEventsResponse.Builder Response message for ListUserEvents method.PlacementName PlacementName.Builder Builder for projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}.PredictionApiKeyRegistration Registered Api Key.PredictionApiKeyRegistration.Builder Registered Api Key.PredictionApiKeyRegistrationName PredictionApiKeyRegistrationName.Builder Builder for projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}.PredictionApiKeyRegistryClient Service Description: Service for registering API keys for use with the `predict` method.PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsFixedSizeCollection PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPage PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse PredictionApiKeyRegistryGrpc Service for registering API keys for use with the `predict` method.PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryBlockingStub A stub to allow clients to do synchronous rpc calls to service PredictionApiKeyRegistry.PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service PredictionApiKeyRegistry.PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryImplBase Base class for the server implementation of the service PredictionApiKeyRegistry.PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryStub A stub to allow clients to do asynchronous rpc calls to service PredictionApiKeyRegistry.PredictionApikeyRegistryService PredictionApiKeyRegistrySettings Settings class to configure an instance ofPredictionApiKeyRegistryClient
.PredictionApiKeyRegistrySettings.Builder Builder for PredictionApiKeyRegistrySettings.PredictionServiceClient Service Description: Service for making recommendation prediction.PredictionServiceClient.PredictFixedSizeCollection PredictionServiceClient.PredictPage PredictionServiceClient.PredictPagedResponse PredictionServiceGrpc Service for making recommendation prediction.PredictionServiceGrpc.PredictionServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service PredictionService.PredictionServiceGrpc.PredictionServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service PredictionService.PredictionServiceGrpc.PredictionServiceImplBase Base class for the server implementation of the service PredictionService.PredictionServiceGrpc.PredictionServiceStub A stub to allow clients to do asynchronous rpc calls to service PredictionService.PredictionServiceOuterClass PredictionServiceSettings Settings class to configure an instance ofPredictionServiceClient
.PredictionServiceSettings.Builder Builder for PredictionServiceSettings.PredictRequest Request message for Predict method.PredictRequest.Builder Request message for Predict method.PredictResponse Response message for predict method.PredictResponse.Builder Response message for predict method.PredictResponse.PredictionResult PredictionResult represents the recommendation prediction results.PredictResponse.PredictionResult.Builder PredictionResult represents the recommendation prediction results.ProductCatalogItem ProductCatalogItem captures item metadata specific to retail products.ProductCatalogItem.Builder ProductCatalogItem captures item metadata specific to retail products.ProductCatalogItem.ExactPrice Exact product price.ProductCatalogItem.ExactPrice.Builder Exact product price.ProductCatalogItem.PriceRange Product price range when there are a range of prices for different variations of the same product.ProductCatalogItem.PriceRange.Builder Product price range when there are a range of prices for different variations of the same product.ProductDetail Detailed product information associated with a user event.ProductDetail.Builder Detailed product information associated with a user event.ProductEventDetail ProductEventDetail captures user event information specific to retail products.ProductEventDetail.Builder ProductEventDetail captures user event information specific to retail products.PurchaseTransaction A transaction represents the entire purchase transaction.PurchaseTransaction.Builder A transaction represents the entire purchase transaction.PurgeUserEventsMetadata Metadata related to the progress of the PurgeUserEvents operation.PurgeUserEventsMetadata.Builder Metadata related to the progress of the PurgeUserEvents operation.PurgeUserEventsRequest Request message for PurgeUserEvents method.PurgeUserEventsRequest.Builder Request message for PurgeUserEvents method.PurgeUserEventsResponse Response of the PurgeUserEventsRequest.PurgeUserEventsResponse.Builder Response of the PurgeUserEventsRequest.RecommendationengineResources UpdateCatalogItemRequest Request message for UpdateCatalogItem method.UpdateCatalogItemRequest.Builder Request message for UpdateCatalogItem method.UserEvent UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.UserEvent.Builder UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.UserEventImportSummary A summary of import result.UserEventImportSummary.Builder A summary of import result.UserEventInlineSource The inline source for the input config for ImportUserEvents method.UserEventInlineSource.Builder The inline source for the input config for ImportUserEvents method.UserEventOuterClass UserEventServiceClient Service Description: Service for ingesting end user actions on the customer website.UserEventServiceClient.ListUserEventsFixedSizeCollection UserEventServiceClient.ListUserEventsPage UserEventServiceClient.ListUserEventsPagedResponse UserEventServiceGrpc Service for ingesting end user actions on the customer website.UserEventServiceGrpc.UserEventServiceBlockingStub A stub to allow clients to do synchronous rpc calls to service UserEventService.UserEventServiceGrpc.UserEventServiceFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service UserEventService.UserEventServiceGrpc.UserEventServiceImplBase Base class for the server implementation of the service UserEventService.UserEventServiceGrpc.UserEventServiceStub A stub to allow clients to do asynchronous rpc calls to service UserEventService.UserEventServiceOuterClass UserEventServiceSettings Settings class to configure an instance ofUserEventServiceClient
.UserEventServiceSettings.Builder Builder for UserEventServiceSettings.UserInfo Information of end users.UserInfo.Builder Information of end users.WriteUserEventRequest Request message for WriteUserEvent method.WriteUserEventRequest.Builder Request message for WriteUserEvent method. -
Enum Summary Enum Description CatalogItem.RecommendationTypeCase ImportErrorsConfig.DestinationCase InputConfig.SourceCase ProductCatalogItem.PriceCase ProductCatalogItem.StockState Item stock state.UserEvent.EventSource User event source.