Class FeaturestoreOnlineServingServiceClient (2.9.8)

public class FeaturestoreOnlineServingServiceClient implements BackgroundResource

Service Description: A service for serving online feature values.

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:


 try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   EntityTypeName entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   ReadFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
 }
 

Note: close() needs to be called on the FeaturestoreOnlineServingServiceClient 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 FeaturestoreOnlineServingServiceSettings to create(). For example:

To customize credentials:


 FeaturestoreOnlineServingServiceSettings featurestoreOnlineServingServiceSettings =
     FeaturestoreOnlineServingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create(featurestoreOnlineServingServiceSettings);
 

To customize the endpoint:


 FeaturestoreOnlineServingServiceSettings featurestoreOnlineServingServiceSettings =
     FeaturestoreOnlineServingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create(featurestoreOnlineServingServiceSettings);
 

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

Inheritance

java.lang.Object > FeaturestoreOnlineServingServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final FeaturestoreOnlineServingServiceClient create()

Constructs an instance of FeaturestoreOnlineServingServiceClient with default settings.

Returns
TypeDescription
FeaturestoreOnlineServingServiceClient
Exceptions
TypeDescription
IOException

create(FeaturestoreOnlineServingServiceSettings settings)

public static final FeaturestoreOnlineServingServiceClient create(FeaturestoreOnlineServingServiceSettings settings)

Constructs an instance of FeaturestoreOnlineServingServiceClient, 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
settingsFeaturestoreOnlineServingServiceSettings
Returns
TypeDescription
FeaturestoreOnlineServingServiceClient
Exceptions
TypeDescription
IOException

create(FeaturestoreOnlineServingServiceStub stub)

public static final FeaturestoreOnlineServingServiceClient create(FeaturestoreOnlineServingServiceStub stub)

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

Parameter
NameDescription
stubFeaturestoreOnlineServingServiceStub
Returns
TypeDescription
FeaturestoreOnlineServingServiceClient

Constructors

FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceSettings settings)

protected FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceSettings settings)

Constructs an instance of FeaturestoreOnlineServingServiceClient, 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
settingsFeaturestoreOnlineServingServiceSettings

FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceStub stub)

protected FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceStub stub)
Parameter
NameDescription
stubFeaturestoreOnlineServingServiceStub

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

getSettings()

public final FeaturestoreOnlineServingServiceSettings getSettings()
Returns
TypeDescription
FeaturestoreOnlineServingServiceSettings

getStub()

public FeaturestoreOnlineServingServiceStub getStub()
Returns
TypeDescription
FeaturestoreOnlineServingServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

readFeatureValues(EntityTypeName entityType)

public final ReadFeatureValuesResponse readFeatureValues(EntityTypeName entityType)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Sample code:


 try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   EntityTypeName entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   ReadFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
 }
 
Parameter
NameDescription
entityTypeEntityTypeName

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

Returns
TypeDescription
ReadFeatureValuesResponse

readFeatureValues(ReadFeatureValuesRequest request)

public final ReadFeatureValuesResponse readFeatureValues(ReadFeatureValuesRequest request)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Sample code:


 try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   ReadFeatureValuesRequest request =
       ReadFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setEntityId("entityId-2102099874")
           .setFeatureSelector(FeatureSelector.newBuilder().build())
           .build();
   ReadFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.readFeatureValues(request);
 }
 
Parameter
NameDescription
requestReadFeatureValuesRequest

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

Returns
TypeDescription
ReadFeatureValuesResponse

readFeatureValues(String entityType)

public final ReadFeatureValuesResponse readFeatureValues(String entityType)

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Sample code:


 try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   String entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   ReadFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
 }
 
Parameter
NameDescription
entityTypeString

Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

Returns
TypeDescription
ReadFeatureValuesResponse

readFeatureValuesCallable()

public final UnaryCallable<ReadFeatureValuesRequest,ReadFeatureValuesResponse> readFeatureValuesCallable()

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

Sample code:


 try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   ReadFeatureValuesRequest request =
       ReadFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .setEntityId("entityId-2102099874")
           .setFeatureSelector(FeatureSelector.newBuilder().build())
           .build();
   ApiFuture<ReadFeatureValuesResponse> future =
       featurestoreOnlineServingServiceClient.readFeatureValuesCallable().futureCall(request);
   // Do something.
   ReadFeatureValuesResponse response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<ReadFeatureValuesRequest,ReadFeatureValuesResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

streamingReadFeatureValuesCallable()

public final ServerStreamingCallable<StreamingReadFeatureValuesRequest,ReadFeatureValuesResponse> streamingReadFeatureValuesCallable()

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

Sample code:


 try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   StreamingReadFeatureValuesRequest request =
       StreamingReadFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllEntityIds(new ArrayList<String>())
           .setFeatureSelector(FeatureSelector.newBuilder().build())
           .build();
   ServerStream<ReadFeatureValuesResponse> stream =
       featurestoreOnlineServingServiceClient.streamingReadFeatureValuesCallable().call(request);
   for (ReadFeatureValuesResponse response : stream) {
     // Do something when a response is received.
   }
 }
 
Returns
TypeDescription
ServerStreamingCallable<StreamingReadFeatureValuesRequest,ReadFeatureValuesResponse>