Class PredictionApiKeyRegistryClient (0.10.2)

Stay organized with collections Save and categorize content based on your preferences.
public class PredictionApiKeyRegistryClient implements 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 PredictionApiKeyRegistrySettings predictionApiKeyRegistrySettings =
     PredictionApiKeyRegistrySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create(predictionApiKeyRegistrySettings);
 

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 PredictionApiKeyRegistrySettings predictionApiKeyRegistrySettings =
     PredictionApiKeyRegistrySettings.newBuilder()
         .setTransportChannelProvider(
             PredictionApiKeyRegistrySettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create(predictionApiKeyRegistrySettings);
 

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

Inheritance

java.lang.Object > PredictionApiKeyRegistryClient

Implements

BackgroundResource

Static Methods

create()

public static final PredictionApiKeyRegistryClient create()

Constructs an instance of PredictionApiKeyRegistryClient with default settings.

Returns
TypeDescription
PredictionApiKeyRegistryClient
Exceptions
TypeDescription
IOException

create(PredictionApiKeyRegistrySettings settings)

public static final PredictionApiKeyRegistryClient create(PredictionApiKeyRegistrySettings settings)

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.

Parameter
NameDescription
settingsPredictionApiKeyRegistrySettings
Returns
TypeDescription
PredictionApiKeyRegistryClient
Exceptions
TypeDescription
IOException

create(PredictionApiKeyRegistryStub stub)

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

Parameter
NameDescription
stubPredictionApiKeyRegistryStub
Returns
TypeDescription
PredictionApiKeyRegistryClient

Constructors

PredictionApiKeyRegistryClient(PredictionApiKeyRegistrySettings settings)

protected PredictionApiKeyRegistryClient(PredictionApiKeyRegistrySettings settings)

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.

Parameter
NameDescription
settingsPredictionApiKeyRegistrySettings

PredictionApiKeyRegistryClient(PredictionApiKeyRegistryStub stub)

protected PredictionApiKeyRegistryClient(PredictionApiKeyRegistryStub stub)
Parameter
NameDescription
stubPredictionApiKeyRegistryStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createPredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request)

public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(CreatePredictionApiKeyRegistrationRequest request)

Register an API key for use with predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
 }
 
Parameter
NameDescription
requestCreatePredictionApiKeyRegistrationRequest

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

Returns
TypeDescription
PredictionApiKeyRegistration

createPredictionApiKeyRegistration(EventStoreName parent, PredictionApiKeyRegistration predictionApiKeyRegistration)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
parentEventStoreName

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

predictionApiKeyRegistrationPredictionApiKeyRegistration

Required. The prediction API key registration.

Returns
TypeDescription
PredictionApiKeyRegistration

createPredictionApiKeyRegistration(String parent, PredictionApiKeyRegistration predictionApiKeyRegistration)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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
NameDescription
parentString

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

predictionApiKeyRegistrationPredictionApiKeyRegistration

Required. The prediction API key registration.

Returns
TypeDescription
PredictionApiKeyRegistration

createPredictionApiKeyRegistrationCallable()

public final UnaryCallable<CreatePredictionApiKeyRegistrationRequest,PredictionApiKeyRegistration> createPredictionApiKeyRegistrationCallable()

Register an API key for use with predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 
Returns
TypeDescription
UnaryCallable<CreatePredictionApiKeyRegistrationRequest,PredictionApiKeyRegistration>

deletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request)

public final void deletePredictionApiKeyRegistration(DeletePredictionApiKeyRegistrationRequest request)

Unregister an apiKey from using for predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
 }
 
Parameter
NameDescription
requestDeletePredictionApiKeyRegistrationRequest

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

deletePredictionApiKeyRegistration(PredictionApiKeyRegistrationName name)

public final void deletePredictionApiKeyRegistration(PredictionApiKeyRegistrationName name)

Unregister an apiKey from using for predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create()) {
   PredictionApiKeyRegistrationName name =
       PredictionApiKeyRegistrationName.of(
           "[PROJECT]",
           "[LOCATION]",
           "[CATALOG]",
           "[EVENT_STORE]",
           "[PREDICTION_API_KEY_REGISTRATION]");
   predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(name);
 }
 
Parameter
NameDescription
namePredictionApiKeyRegistrationName

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

deletePredictionApiKeyRegistration(String name)

public final void deletePredictionApiKeyRegistration(String name)

Unregister an apiKey from using for predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create()) {
   String name =
       PredictionApiKeyRegistrationName.of(
               "[PROJECT]",
               "[LOCATION]",
               "[CATALOG]",
               "[EVENT_STORE]",
               "[PREDICTION_API_KEY_REGISTRATION]")
           .toString();
   predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(name);
 }
 
Parameter
NameDescription
nameString

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

deletePredictionApiKeyRegistrationCallable()

public final UnaryCallable<DeletePredictionApiKeyRegistrationRequest,Empty> deletePredictionApiKeyRegistrationCallable()

Unregister an apiKey from using for predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 
Returns
TypeDescription
UnaryCallable<DeletePredictionApiKeyRegistrationRequest,Empty>

getSettings()

public final PredictionApiKeyRegistrySettings getSettings()
Returns
TypeDescription
PredictionApiKeyRegistrySettings

getStub()

public PredictionApiKeyRegistryStub getStub()
Returns
TypeDescription
PredictionApiKeyRegistryStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listPredictionApiKeyRegistrations(EventStoreName parent)

public final PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(EventStoreName parent)

List the registered apiKeys for use with predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create()) {
   EventStoreName parent =
       EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
   for (PredictionApiKeyRegistration element :
       predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentEventStoreName

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

Returns
TypeDescription
PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse

listPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request)

public final PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(ListPredictionApiKeyRegistrationsRequest request)

List the registered apiKeys for use with predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 
Parameter
NameDescription
requestListPredictionApiKeyRegistrationsRequest

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

Returns
TypeDescription
PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse

listPredictionApiKeyRegistrations(String parent)

public final PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKeyRegistrations(String parent)

List the registered apiKeys for use with predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
     PredictionApiKeyRegistryClient.create()) {
   String parent =
       EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
   for (PredictionApiKeyRegistration element :
       predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

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

Returns
TypeDescription
PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse

listPredictionApiKeyRegistrationsCallable()

public final UnaryCallable<ListPredictionApiKeyRegistrationsRequest,ListPredictionApiKeyRegistrationsResponse> listPredictionApiKeyRegistrationsCallable()

List the registered apiKeys for use with predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListPredictionApiKeyRegistrationsRequest,ListPredictionApiKeyRegistrationsResponse>

listPredictionApiKeyRegistrationsPagedCallable()

public final UnaryCallable<ListPredictionApiKeyRegistrationsRequest,PredictionApiKeyRegistryClient.ListPredictionApiKeyRegistrationsPagedResponse> listPredictionApiKeyRegistrationsPagedCallable()

List the registered apiKeys for use with predict method.

Sample code:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListPredictionApiKeyRegistrationsRequest,ListPredictionApiKeyRegistrationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()