Package com.google.cloud.recommendationengine.v1beta1

Class PredictionApiKeyRegistryClient

java.lang.Object

com.google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistryClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
@Generated("by gapic-generator-java")
public class PredictionApiKeyRegistryClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsFixedSizeCollection
static class	PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPage
static class	PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PredictionApiKeyRegistryClient(PredictionApiKeyRegistrySettings settings)	Constructs an instance of PredictionApiKeyRegistryClient, using the given settings.
protected	PredictionApiKeyRegistryClient(PredictionApiKeyRegistryStub stub)

Method Summary

Modifier and Type	Method	Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static PredictionApiKeyRegistryClient	create()	Constructs an instance of PredictionApiKeyRegistryClient with default settings.
static PredictionApiKeyRegistryClient	create(PredictionApiKeyRegistrySettings settings)	Constructs an instance of PredictionApiKeyRegistryClient, using the given settings.
static PredictionApiKeyRegistryClient	create(PredictionApiKeyRegistryStub stub)	Constructs an instance of PredictionApiKeyRegistryClient, using the given stub for making calls.
PredictionApiKeyRegistration	createPredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request)	Register an API key for use with predict method.
PredictionApiKeyRegistration	createPredictionApiKeyRegistration(EventStoreName parent, PredictionApiKeyRegistration predictionApiKeyRegistration)	Register an API key for use with predict method.
PredictionApiKeyRegistration	createPredictionApiKeyRegistration(String parent, PredictionApiKeyRegistration predictionApiKeyRegistration)	Register an API key for use with predict method.
com.google.api.gax.rpc.UnaryCallable<CreatePredictionApiKeyRegistrationRequest,PredictionApiKeyRegistration>	createPredictionApiKeyRegistrationCallable()	Register an API key for use with predict method.
void	deletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request)	Unregister an apiKey from using for predict method.
void	deletePredictionApiKeyRegistration(PredictionApiKeyRegistrationName name)	Unregister an apiKey from using for predict method.
void	deletePredictionApiKeyRegistration(String name)	Unregister an apiKey from using for predict method.
com.google.api.gax.rpc.UnaryCallable<DeletePredictionApiKeyRegistrationRequest,com.google.protobuf.Empty>	deletePredictionApiKeyRegistrationCallable()	Unregister an apiKey from using for predict method.
PredictionApiKeyRegistrySettings	getSettings()
PredictionApiKeyRegistryStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse	listPredictionApiKeyRegistrations(EventStoreName parent)	List the registered apiKeys for use with predict method.
PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse	listPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request)	List the registered apiKeys for use with predict method.
PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse	listPredictionApiKeyRegistrations(String parent)	List the registered apiKeys for use with predict method.
com.google.api.gax.rpc.UnaryCallable<ListPredictionApiKeyRegistrationsRequest,ListPredictionApiKeyRegistrationsResponse>	listPredictionApiKeyRegistrationsCallable()	List the registered apiKeys for use with predict method.
com.google.api.gax.rpc.UnaryCallable<ListPredictionApiKeyRegistrationsRequest,PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse>	listPredictionApiKeyRegistrationsPagedCallable()	List the registered apiKeys for use with predict method.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PredictionApiKeyRegistryClient

protected PredictionApiKeyRegistryClient(PredictionApiKeyRegistrySettings settings)
                                  throws IOException

Constructs an instance of PredictionApiKeyRegistryClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

PredictionApiKeyRegistryClient

protected PredictionApiKeyRegistryClient(PredictionApiKeyRegistryStub stub)

Method Detail

create

public static final PredictionApiKeyRegistryClient create()
                                                   throws IOException

Constructs an instance of PredictionApiKeyRegistryClient with default settings.

Throws:

IOException

create

public static final PredictionApiKeyRegistryClient create(PredictionApiKeyRegistrySettings settings)
                                                   throws IOException

Constructs an instance of PredictionApiKeyRegistryClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final PredictionApiKeyRegistryClient create(PredictionApiKeyRegistryStub stub)

Constructs an instance of PredictionApiKeyRegistryClient, using the given stub for making calls. This is for advanced usage - prefer using create(PredictionApiKeyRegistrySettings).

getSettings

public final PredictionApiKeyRegistrySettings getSettings()

getStub

public PredictionApiKeyRegistryStub getStub()

createPredictionApiKeyRegistration

public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(EventStoreName parent,
                                                                             PredictionApiKeyRegistration predictionApiKeyRegistration)

Register an API key for use with predict method.

Sample code:

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

Parameters:

parent - Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.

predictionApiKeyRegistration - Required. The prediction API key registration.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createPredictionApiKeyRegistration

public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(String parent,
                                                                             PredictionApiKeyRegistration predictionApiKeyRegistration)

Register an API key for use with predict method.

Sample code:

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

Parameters:

parent - Required. The parent resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store`.

predictionApiKeyRegistration - Required. The prediction API key registration.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createPredictionApiKeyRegistration

public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request)

Register an API key for use with predict method.

Sample code:

 // 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()) {
   CreatePredictionApiKeyRegistrationRequest request =
       CreatePredictionApiKeyRegistrationRequest.newBuilder()
           .setParent(
               EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
                   .toString())
           .setPredictionApiKeyRegistration(PredictionApiKeyRegistration.newBuilder().build())
           .build();
   PredictionApiKeyRegistration response =
       predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createPredictionApiKeyRegistrationCallable

public final com.google.api.gax.rpc.UnaryCallable<CreatePredictionApiKeyRegistrationRequest,PredictionApiKeyRegistration> createPredictionApiKeyRegistrationCallable()

Register an API key for use with predict method.

Sample code:

 // 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()) {
   CreatePredictionApiKeyRegistrationRequest request =
       CreatePredictionApiKeyRegistrationRequest.newBuilder()
           .setParent(
               EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
                   .toString())
           .setPredictionApiKeyRegistration(PredictionApiKeyRegistration.newBuilder().build())
           .build();
   ApiFuture<PredictionApiKeyRegistration> future =
       predictionApiKeyRegistryClient
           .createPredictionApiKeyRegistrationCallable()
           .futureCall(request);
   // Do something.
   PredictionApiKeyRegistration response = future.get();
 }
 

listPredictionApiKeyRegistrations

public final PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(EventStoreName parent)

List the registered apiKeys for use with predict method.

Sample code:

 // 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]");
   for (PredictionApiKeyRegistration element :
       predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPredictionApiKeyRegistrations

public final PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(String parent)

List the registered apiKeys for use with predict method.

Sample code:

 // 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()) {
   String parent =
       EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
   for (PredictionApiKeyRegistration element :
       predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent placement resource name such as `projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPredictionApiKeyRegistrations

public final PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request)

List the registered apiKeys for use with predict method.

Sample code:

 // 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()) {
   ListPredictionApiKeyRegistrationsRequest request =
       ListPredictionApiKeyRegistrationsRequest.newBuilder()
           .setParent(
               EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (PredictionApiKeyRegistration element :
       predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listPredictionApiKeyRegistrationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListPredictionApiKeyRegistrationsRequest,PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse> listPredictionApiKeyRegistrationsPagedCallable()

List the registered apiKeys for use with predict method.

Sample code:

 // 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()) {
   ListPredictionApiKeyRegistrationsRequest request =
       ListPredictionApiKeyRegistrationsRequest.newBuilder()
           .setParent(
               EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<PredictionApiKeyRegistration> future =
       predictionApiKeyRegistryClient
           .listPredictionApiKeyRegistrationsPagedCallable()
           .futureCall(request);
   // Do something.
   for (PredictionApiKeyRegistration element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listPredictionApiKeyRegistrationsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListPredictionApiKeyRegistrationsRequest,ListPredictionApiKeyRegistrationsResponse> listPredictionApiKeyRegistrationsCallable()

List the registered apiKeys for use with predict method.

Sample code:

 // 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()) {
   ListPredictionApiKeyRegistrationsRequest request =
       ListPredictionApiKeyRegistrationsRequest.newBuilder()
           .setParent(
               EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListPredictionApiKeyRegistrationsResponse response =
         predictionApiKeyRegistryClient
             .listPredictionApiKeyRegistrationsCallable()
             .call(request);
     for (PredictionApiKeyRegistration element :
         response.getPredictionApiKeyRegistrationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deletePredictionApiKeyRegistration

public final void deletePredictionApiKeyRegistration(PredictionApiKeyRegistrationName name)

Unregister an apiKey from using for predict method.

Sample code:

 // 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()) {
   PredictionApiKeyRegistrationName name =
       PredictionApiKeyRegistrationName.of(
           "[PROJECT]",
           "[LOCATION]",
           "[CATALOG]",
           "[EVENT_STORE]",
           "[PREDICTION_API_KEY_REGISTRATION]");
   predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(name);
 }
 

Parameters:

name - Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deletePredictionApiKeyRegistration

public final void deletePredictionApiKeyRegistration(String name)

Unregister an apiKey from using for predict method.

Sample code:

 // 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()) {
   String name =
       PredictionApiKeyRegistrationName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[CATALOG]",
               "[EVENT_STORE]",
               "[PREDICTION_API_KEY_REGISTRATION]")
           .toString();
   predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(name);
 }
 

Parameters:

name - Required. The API key to unregister including full resource path. `projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deletePredictionApiKeyRegistration

public final void deletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request)

Unregister an apiKey from using for predict method.

Sample code:

 // 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()) {
   DeletePredictionApiKeyRegistrationRequest request =
       DeletePredictionApiKeyRegistrationRequest.newBuilder()
           .setName(
               PredictionApiKeyRegistrationName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[CATALOG]",
                       "[EVENT_STORE]",
                       "[PREDICTION_API_KEY_REGISTRATION]")
                   .toString())
           .build();
   predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deletePredictionApiKeyRegistrationCallable

public final com.google.api.gax.rpc.UnaryCallable<DeletePredictionApiKeyRegistrationRequest,com.google.protobuf.Empty> deletePredictionApiKeyRegistrationCallable()

Unregister an apiKey from using for predict method.

Sample code:

 // 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()) {
   DeletePredictionApiKeyRegistrationRequest request =
       DeletePredictionApiKeyRegistrationRequest.newBuilder()
           .setName(
               PredictionApiKeyRegistrationName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[CATALOG]",
                       "[EVENT_STORE]",
                       "[PREDICTION_API_KEY_REGISTRATION]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       predictionApiKeyRegistryClient
           .deletePredictionApiKeyRegistrationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException