Package com.google.cloud.recommendationengine.v1beta1 (0.36.0)

The inline source for the input config for ImportCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogInlineSource

The inline source for the input config for ImportCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogInlineSource

CatalogItem captures all metadata information of items to be recommended.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogItem

CatalogItem captures all metadata information of items to be recommended.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogItem

Category represents catalog item category hierarchy.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy

Category represents catalog item category hierarchy.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy

Builder for projects/{project}/locations/{location}/catalogs/{catalog}/catalogItems/{catalog_item_path}.

Builder for projects/{project}/locations/{location}/catalogs/{catalog}.

Service Description: Service for ingesting catalog 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 (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
   CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   CatalogItem catalogItem = CatalogItem.newBuilder().build();
   CatalogItem response = catalogServiceClient.createCatalogItem(parent, catalogItem);
 }
 

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:

1. 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.
2. 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.
3. 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.newHttpJsonBuilder().build();
 CatalogServiceClient catalogServiceClient = CatalogServiceClient.create(catalogServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Service for ingesting catalog information of the customer's website.

A stub to allow clients to do synchronous rpc calls to service CatalogService.

Service for ingesting catalog information of the customer's website.

A stub to allow clients to do ListenableFuture-style rpc calls to service CatalogService.

Service for ingesting catalog information of the customer's website.

Base class for the server implementation of the service CatalogService.

Service for ingesting catalog information of the customer's website.

A stub to allow clients to do asynchronous rpc calls to service CatalogService.

Service for ingesting catalog information of the customer's website.

Settings class to configure an instance of CatalogServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (recommendationengine.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 createCatalogItem 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
     .createCatalogItemSettings()
     .setRetrySettings(
         catalogServiceSettingsBuilder
             .createCatalogItemSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CatalogServiceSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();
 

Builder for CatalogServiceSettings.

Request message for CollectUserEvent method.

Protobuf type google.cloud.recommendationengine.v1beta1.CollectUserEventRequest

Request message for CollectUserEvent method.

Protobuf type google.cloud.recommendationengine.v1beta1.CollectUserEventRequest

Request message for CreateCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreateCatalogItemRequest

Request message for CreateCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreateCatalogItemRequest

Request message for the CreatePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreatePredictionApiKeyRegistrationRequest

Request message for the CreatePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreatePredictionApiKeyRegistrationRequest

Request message for DeleteCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeleteCatalogItemRequest

Request message for DeleteCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeleteCatalogItemRequest

Request message for DeletePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeletePredictionApiKeyRegistrationRequest

Request message for DeletePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeletePredictionApiKeyRegistrationRequest

User event details shared by all recommendation types.

Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail

User event details shared by all recommendation types.

Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail

Builder for projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}.

FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap

FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap

A list of float features.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList

A list of float features.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList

A list of string features.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap.StringList

A list of string features.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap.StringList

Google Cloud Storage location for input content. format.

Protobuf type google.cloud.recommendationengine.v1beta1.GcsSource

Google Cloud Storage location for input content. format.

Protobuf type google.cloud.recommendationengine.v1beta1.GcsSource

Request message for GetCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.GetCatalogItemRequest

Request message for GetCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.GetCatalogItemRequest

Catalog item thumbnail/detail image.

Protobuf type google.cloud.recommendationengine.v1beta1.Image

Catalog item thumbnail/detail image.

Protobuf type google.cloud.recommendationengine.v1beta1.Image

Request message for Import methods.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportCatalogItemsRequest

Request message for Import methods.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportCatalogItemsRequest

Response of the ImportCatalogItemsRequest. 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.recommendationengine.v1beta1.ImportCatalogItemsResponse

Response of the ImportCatalogItemsRequest. 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.recommendationengine.v1beta1.ImportCatalogItemsResponse

Configuration of destination for Import related errors.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportErrorsConfig

Configuration of destination for Import related errors.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportErrorsConfig

Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportMetadata

Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportMetadata

Request message for the ImportUserEvents request.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportUserEventsRequest

Request message for the ImportUserEvents request.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportUserEventsRequest

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.recommendationengine.v1beta1.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.recommendationengine.v1beta1.ImportUserEventsResponse

The input config source.

Protobuf type google.cloud.recommendationengine.v1beta1.InputConfig

The input config source.

Protobuf type google.cloud.recommendationengine.v1beta1.InputConfig

Request message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsRequest

Request message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsRequest

Response message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsResponse

Response message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsResponse

Request message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsRequest

Request message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsRequest

Response message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsResponse

Response message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsResponse

Request message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsRequest

Request message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsRequest

Response message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsResponse

Response message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsResponse

Builder for projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}.

Request message for Predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest

Request message for Predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest

Response message for predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse

Response message for predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse

PredictionResult represents the recommendation prediction results.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult

PredictionResult represents the recommendation prediction results.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult

Registered Api Key.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistration

Registered Api Key.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistration

Builder for projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/predictionApiKeyRegistrations/{prediction_api_key_registration}.

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.

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 (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create()) {
   EventStoreName parent =
       EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
   PredictionApiKeyRegistration predictionApiKeyRegistration =
       PredictionApiKeyRegistration.newBuilder().build();
   PredictionApiKeyRegistration response =
       predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(
           parent, predictionApiKeyRegistration);
 }
 

Note: close() needs to be called on the PredictionApiKeyRegistryClient 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:

1. 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.
2. 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.
3. 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 PredictionApiKeyRegistrySettings 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
 PredictionApiKeyRegistrySettings predictionApiKeyRegistrySettings =
     PredictionApiKeyRegistrySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create(predictionApiKeyRegistrySettings);
 

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
 PredictionApiKeyRegistrySettings predictionApiKeyRegistrySettings =
     PredictionApiKeyRegistrySettings.newBuilder().setEndpoint(myEndpoint).build();
 PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create(predictionApiKeyRegistrySettings);
 

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
 PredictionApiKeyRegistrySettings predictionApiKeyRegistrySettings =
     PredictionApiKeyRegistrySettings.newHttpJsonBuilder().build();
 PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create(predictionApiKeyRegistrySettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

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.

A stub to allow clients to do synchronous rpc calls to service PredictionApiKeyRegistry.

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.

A stub to allow clients to do ListenableFuture-style rpc calls to service PredictionApiKeyRegistry.

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.

Base class for the server implementation of the service PredictionApiKeyRegistry.

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.

A stub to allow clients to do asynchronous rpc calls to service PredictionApiKeyRegistry.

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.

Settings class to configure an instance of PredictionApiKeyRegistryClient.

The default instance has everything set to sensible defaults:

• The default service address (recommendationengine.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 createPredictionApiKeyRegistration 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
 PredictionApiKeyRegistrySettings.Builder predictionApiKeyRegistrySettingsBuilder =
     PredictionApiKeyRegistrySettings.newBuilder();
 predictionApiKeyRegistrySettingsBuilder
     .createPredictionApiKeyRegistrationSettings()
     .setRetrySettings(
         predictionApiKeyRegistrySettingsBuilder
             .createPredictionApiKeyRegistrationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PredictionApiKeyRegistrySettings predictionApiKeyRegistrySettings =
     predictionApiKeyRegistrySettingsBuilder.build();
 

Builder for PredictionApiKeyRegistrySettings.

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()) {
   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);
   }
 }
 

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:

1. 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.
2. 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.
3. 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.newHttpJsonBuilder().build();
 PredictionServiceClient predictionServiceClient =
     PredictionServiceClient.create(predictionServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Service for making recommendation prediction.

A stub to allow clients to do synchronous rpc calls to service PredictionService.

Service for making recommendation prediction.

A stub to allow clients to do ListenableFuture-style rpc calls to service PredictionService.

Service for making recommendation prediction.

Base class for the server implementation of the service PredictionService.

Service for making recommendation prediction.

A stub to allow clients to do asynchronous rpc calls to service PredictionService.

Service for making recommendation prediction.

Settings class to configure an instance of PredictionServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (recommendationengine.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();
 

Builder for PredictionServiceSettings.

ProductCatalogItem captures item metadata specific to retail products.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductCatalogItem

ProductCatalogItem captures item metadata specific to retail products.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductCatalogItem

Exact product price.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductCatalogItem.ExactPrice

Exact product price.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductCatalogItem.ExactPrice

Product price range when there are a range of prices for different variations of the same product.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductCatalogItem.PriceRange

Product price range when there are a range of prices for different variations of the same product.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductCatalogItem.PriceRange

Detailed product information associated with a user event.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductDetail

Detailed product information associated with a user event.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductDetail

ProductEventDetail captures user event information specific to retail products.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductEventDetail

ProductEventDetail captures user event information specific to retail products.

Protobuf type google.cloud.recommendationengine.v1beta1.ProductEventDetail

A transaction represents the entire purchase transaction.

Protobuf type google.cloud.recommendationengine.v1beta1.PurchaseTransaction

A transaction represents the entire purchase transaction.

Protobuf type google.cloud.recommendationengine.v1beta1.PurchaseTransaction

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsMetadata

Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.

Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsMetadata

Request message for PurgeUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest

Request message for PurgeUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest

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.recommendationengine.v1beta1.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.recommendationengine.v1beta1.PurgeUserEventsResponse

Request message for UpdateCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.UpdateCatalogItemRequest

Request message for UpdateCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.UpdateCatalogItemRequest

UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.

Protobuf type google.cloud.recommendationengine.v1beta1.UserEvent

UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.

Protobuf type google.cloud.recommendationengine.v1beta1.UserEvent

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

Protobuf type google.cloud.recommendationengine.v1beta1.UserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

Protobuf type google.cloud.recommendationengine.v1beta1.UserEventImportSummary

The inline source for the input config for ImportUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.UserEventInlineSource

The inline source for the input config for ImportUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.UserEventInlineSource

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()) {
   EventStoreName parent =
       EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
   UserEvent userEvent = UserEvent.newBuilder().build();
   UserEvent response = userEventServiceClient.writeUserEvent(parent, userEvent);
 }
 

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:

1. 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.
2. 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.
3. 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.newHttpJsonBuilder().build();
 UserEventServiceClient userEventServiceClient =
     UserEventServiceClient.create(userEventServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Service for ingesting end user actions on the customer website.

A stub to allow clients to do synchronous rpc calls to service UserEventService.

Service for ingesting end user actions on the customer website.

A stub to allow clients to do ListenableFuture-style rpc calls to service UserEventService.

Service for ingesting end user actions on the customer website.

Base class for the server implementation of the service UserEventService.

Service for ingesting end user actions on the customer website.

A stub to allow clients to do asynchronous rpc calls to service UserEventService.

Service for ingesting end user actions on the customer website.

Settings class to configure an instance of UserEventServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (recommendationengine.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();
 

Builder for UserEventServiceSettings.

Information of end users.

Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo

Information of end users.

Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo

Request message for WriteUserEvent method.

Protobuf type google.cloud.recommendationengine.v1beta1.WriteUserEventRequest

Request message for WriteUserEvent method.

Protobuf type google.cloud.recommendationengine.v1beta1.WriteUserEventRequest

Service for ingesting catalog information of the customer's website.

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.

Service for making recommendation prediction.

Service for ingesting end user actions on the customer website.

Item stock state. If this field is unspecified, the item is assumed to be in stock.

Protobuf enum google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState

User event source.

Protobuf enum google.cloud.recommendationengine.v1beta1.UserEvent.EventSource