Class FeaturestoreOnlineServingServiceClient (3.48.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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:


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

Methods
Method Description Method Variants

ReadFeatureValues

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • readFeatureValues(ReadFeatureValuesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • readFeatureValues(EntityTypeName entityType)

  • readFeatureValues(String entityType)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • readFeatureValuesCallable()

StreamingReadFeatureValues

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

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • streamingReadFeatureValuesCallable()

WriteFeatureValues

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • writeFeatureValues(WriteFeatureValuesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • writeFeatureValues(EntityTypeName entityType, List<WriteFeatureValuesPayload> payloads)

  • writeFeatureValues(String entityType, List<WriteFeatureValuesPayload> payloads)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • writeFeatureValuesCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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:


 // 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
 FeaturestoreOnlineServingServiceSettings featurestoreOnlineServingServiceSettings =
     FeaturestoreOnlineServingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create(featurestoreOnlineServingServiceSettings);

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

Static Methods

create()

public static final FeaturestoreOnlineServingServiceClient create()

Constructs an instance of FeaturestoreOnlineServingServiceClient with default settings.

Returns
Type Description
FeaturestoreOnlineServingServiceClient
Exceptions
Type Description
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
Name Description
settings FeaturestoreOnlineServingServiceSettings
Returns
Type Description
FeaturestoreOnlineServingServiceClient
Exceptions
Type Description
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
Name Description
stub FeaturestoreOnlineServingServiceStub
Returns
Type Description
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
Name Description
settings FeaturestoreOnlineServingServiceSettings

FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceStub stub)

protected FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceStub stub)
Parameter
Name Description
stub FeaturestoreOnlineServingServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = featurestoreOnlineServingServiceClient.getIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       featurestoreOnlineServingServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = featurestoreOnlineServingServiceClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       featurestoreOnlineServingServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final FeaturestoreOnlineServingServiceSettings getSettings()
Returns
Type Description
FeaturestoreOnlineServingServiceSettings

getStub()

public FeaturestoreOnlineServingServiceStub getStub()
Returns
Type Description
FeaturestoreOnlineServingServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final FeaturestoreOnlineServingServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element :
       featurestoreOnlineServingServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
FeaturestoreOnlineServingServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         featurestoreOnlineServingServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,FeaturestoreOnlineServingServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       featurestoreOnlineServingServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

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:


 // 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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   EntityTypeName entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   ReadFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
 }
Parameter
Name Description
entityType EntityTypeName

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
Type Description
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:


 // 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 (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
Name Description
request ReadFeatureValuesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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:


 // 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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   String entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   ReadFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
 }
Parameter
Name Description
entityType String

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
Type Description
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:


 // 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 (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
Type Description
UnaryCallable<ReadFeatureValuesRequest,ReadFeatureValuesResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = featurestoreOnlineServingServiceClient.setIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       featurestoreOnlineServingServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

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:


 // 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 (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
Type Description
ServerStreamingCallable<StreamingReadFeatureValuesRequest,ReadFeatureValuesResponse>

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       featurestoreOnlineServingServiceClient.testIamPermissions(request);
 }
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       featurestoreOnlineServingServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

writeFeatureValues(EntityTypeName entityType, List<WriteFeatureValuesPayload> payloads)

public final WriteFeatureValuesResponse writeFeatureValues(EntityTypeName entityType, List<WriteFeatureValuesPayload> payloads)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   EntityTypeName entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
   List<WriteFeatureValuesPayload> payloads = new ArrayList<>();
   WriteFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.writeFeatureValues(entityType, payloads);
 }
Parameters
Name Description
entityType EntityTypeName

Required. The resource name of the EntityType for the entities being written. 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.
payloads List<WriteFeatureValuesPayload>

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.
Returns
Type Description
WriteFeatureValuesResponse

writeFeatureValues(WriteFeatureValuesRequest request)

public final WriteFeatureValuesResponse writeFeatureValues(WriteFeatureValuesRequest request)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   WriteFeatureValuesRequest request =
       WriteFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllPayloads(new ArrayList<WriteFeatureValuesPayload>())
           .build();
   WriteFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.writeFeatureValues(request);
 }
Parameter
Name Description
request WriteFeatureValuesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
WriteFeatureValuesResponse

writeFeatureValues(String entityType, List<WriteFeatureValuesPayload> payloads)

public final WriteFeatureValuesResponse writeFeatureValues(String entityType, List<WriteFeatureValuesPayload> payloads)

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   String entityType =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
           .toString();
   List<WriteFeatureValuesPayload> payloads = new ArrayList<>();
   WriteFeatureValuesResponse response =
       featurestoreOnlineServingServiceClient.writeFeatureValues(entityType, payloads);
 }
Parameters
Name Description
entityType String

Required. The resource name of the EntityType for the entities being written. 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.
payloads List<WriteFeatureValuesPayload>

Required. The entities to be written. Up to 100,000 feature values can be written across all payloads.
Returns
Type Description
WriteFeatureValuesResponse

writeFeatureValuesCallable()

public final UnaryCallable<WriteFeatureValuesRequest,WriteFeatureValuesResponse> writeFeatureValuesCallable()

Writes Feature values of one or more entities of an EntityType.

The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

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 (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
     FeaturestoreOnlineServingServiceClient.create()) {
   WriteFeatureValuesRequest request =
       WriteFeatureValuesRequest.newBuilder()
           .setEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
                   .toString())
           .addAllPayloads(new ArrayList<WriteFeatureValuesPayload>())
           .build();
   ApiFuture<WriteFeatureValuesResponse> future =
       featurestoreOnlineServingServiceClient.writeFeatureValuesCallable().futureCall(request);
   // Do something.
   WriteFeatureValuesResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<WriteFeatureValuesRequest,WriteFeatureValuesResponse>