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

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

Classes

Catalog

CatalogInlineSource

The inline source for the input config for ImportCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogInlineSource

CatalogInlineSource.Builder

The inline source for the input config for ImportCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogInlineSource

CatalogItem

CatalogItem captures all metadata information of items to be recommended.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogItem

CatalogItem.Builder

CatalogItem captures all metadata information of items to be recommended.

Protobuf type google.cloud.recommendationengine.v1beta1.CatalogItem

CatalogItem.CategoryHierarchy

Category represents catalog item category hierarchy.

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

CatalogItem.CategoryHierarchy.Builder

Category represents catalog item category hierarchy.

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

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.

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:

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

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

CatalogServiceClient.ListCatalogItemsFixedSizeCollection

CatalogServiceClient.ListCatalogItemsPage

CatalogServiceClient.ListCatalogItemsPagedResponse

CatalogServiceGrpc

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

CatalogServiceGrpc.CatalogServiceBlockingStub

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

CatalogServiceGrpc.CatalogServiceFutureStub

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

CatalogServiceGrpc.CatalogServiceImplBase

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

CatalogServiceGrpc.CatalogServiceStub

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

CatalogServiceOuterClass

CatalogServiceSettings

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

CatalogServiceSettings.Builder

Builder for CatalogServiceSettings.

CollectUserEventRequest

Request message for CollectUserEvent method.

Protobuf type google.cloud.recommendationengine.v1beta1.CollectUserEventRequest

CollectUserEventRequest.Builder

Request message for CollectUserEvent method.

Protobuf type google.cloud.recommendationengine.v1beta1.CollectUserEventRequest

Common

CreateCatalogItemRequest

Request message for CreateCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreateCatalogItemRequest

CreateCatalogItemRequest.Builder

Request message for CreateCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreateCatalogItemRequest

CreatePredictionApiKeyRegistrationRequest

Request message for the CreatePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreatePredictionApiKeyRegistrationRequest

CreatePredictionApiKeyRegistrationRequest.Builder

Request message for the CreatePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.CreatePredictionApiKeyRegistrationRequest

DeleteCatalogItemRequest

Request message for DeleteCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeleteCatalogItemRequest

DeleteCatalogItemRequest.Builder

Request message for DeleteCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeleteCatalogItemRequest

DeletePredictionApiKeyRegistrationRequest

Request message for DeletePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeletePredictionApiKeyRegistrationRequest

DeletePredictionApiKeyRegistrationRequest.Builder

Request message for DeletePredictionApiKeyRegistration method.

Protobuf type google.cloud.recommendationengine.v1beta1.DeletePredictionApiKeyRegistrationRequest

EventDetail

User event details shared by all recommendation types.

Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail

EventDetail.Builder

User event details shared by all recommendation types.

Protobuf type google.cloud.recommendationengine.v1beta1.EventDetail

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.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap

FeatureMap.Builder

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.FloatList

A list of float features.

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

FeatureMap.FloatList.Builder

A list of float features.

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

FeatureMap.StringList

A list of string features.

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

FeatureMap.StringList.Builder

A list of string features.

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

GcsSource

Google Cloud Storage location for input content. format.

Protobuf type google.cloud.recommendationengine.v1beta1.GcsSource

GcsSource.Builder

Google Cloud Storage location for input content. format.

Protobuf type google.cloud.recommendationengine.v1beta1.GcsSource

GetCatalogItemRequest

Request message for GetCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.GetCatalogItemRequest

GetCatalogItemRequest.Builder

Request message for GetCatalogItem method.

Protobuf type google.cloud.recommendationengine.v1beta1.GetCatalogItemRequest

Image

Catalog item thumbnail/detail image.

Protobuf type google.cloud.recommendationengine.v1beta1.Image

Image.Builder

Catalog item thumbnail/detail image.

Protobuf type google.cloud.recommendationengine.v1beta1.Image

Import

ImportCatalogItemsRequest

Request message for Import methods.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportCatalogItemsRequest

ImportCatalogItemsRequest.Builder

Request message for Import methods.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportCatalogItemsRequest

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

ImportCatalogItemsResponse.Builder

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

ImportErrorsConfig

Configuration of destination for Import related errors.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportErrorsConfig

ImportErrorsConfig.Builder

Configuration of destination for Import related errors.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportErrorsConfig

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

ImportMetadata.Builder

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

ImportUserEventsRequest

Request message for the ImportUserEvents request.

Protobuf type google.cloud.recommendationengine.v1beta1.ImportUserEventsRequest

ImportUserEventsRequest.Builder

Request message for the ImportUserEvents request.

Protobuf type google.cloud.recommendationengine.v1beta1.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.recommendationengine.v1beta1.ImportUserEventsResponse

ImportUserEventsResponse.Builder

Protobuf type google.cloud.recommendationengine.v1beta1.ImportUserEventsResponse

InputConfig

The input config source.

Protobuf type google.cloud.recommendationengine.v1beta1.InputConfig

InputConfig.Builder

The input config source.

Protobuf type google.cloud.recommendationengine.v1beta1.InputConfig

ListCatalogItemsRequest

Request message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsRequest

ListCatalogItemsRequest.Builder

Request message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsRequest

ListCatalogItemsResponse

Response message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsResponse

ListCatalogItemsResponse.Builder

Response message for ListCatalogItems method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListCatalogItemsResponse

ListPredictionApiKeyRegistrationsRequest

Request message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsRequest

ListPredictionApiKeyRegistrationsRequest.Builder

Request message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsRequest

ListPredictionApiKeyRegistrationsResponse

Response message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsResponse

ListPredictionApiKeyRegistrationsResponse.Builder

Response message for the ListPredictionApiKeyRegistrations.

Protobuf type google.cloud.recommendationengine.v1beta1.ListPredictionApiKeyRegistrationsResponse

ListUserEventsRequest

Request message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsRequest

ListUserEventsRequest.Builder

Request message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsRequest

ListUserEventsResponse

Response message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsResponse

ListUserEventsResponse.Builder

Response message for ListUserEvents method.

Protobuf type google.cloud.recommendationengine.v1beta1.ListUserEventsResponse

PlacementName

PlacementName.Builder

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

PredictRequest

Request message for Predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest

PredictRequest.Builder

Request message for Predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest

PredictResponse

Response message for predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse

PredictResponse.Builder

Response message for predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse

PredictResponse.PredictionResult

PredictionResult represents the recommendation prediction results.

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

PredictResponse.PredictionResult.Builder

PredictionResult represents the recommendation prediction results.

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

PredictionApiKeyRegistration

Registered Api Key.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistration

PredictionApiKeyRegistration.Builder

Registered Api Key.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistration

PredictionApiKeyRegistrationName

PredictionApiKeyRegistrationName.Builder

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

PredictionApiKeyRegistryClient

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:

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.

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.

PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsFixedSizeCollection

PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPage

PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse

PredictionApiKeyRegistryGrpc

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.

PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryBlockingStub

PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryFutureStub

PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryImplBase

PredictionApiKeyRegistryGrpc.PredictionApiKeyRegistryStub

PredictionApiKeyRegistrySettings

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

PredictionApiKeyRegistrySettings.Builder

Builder for PredictionApiKeyRegistrySettings.

PredictionApikeyRegistryService

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()) {
   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:

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.

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.