- 3.48.0 (latest)
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
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:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of FeaturestoreOnlineServingServiceSettings 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.
FeaturestoreOnlineServingServiceSettings featurestoreOnlineServingServiceSettings =
FeaturestoreOnlineServingServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create(featurestoreOnlineServingServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
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.
Implements
BackgroundResourceStatic Methods
create()
public static final FeaturestoreOnlineServingServiceClient create()
Constructs an instance of FeaturestoreOnlineServingServiceClient with default settings.
Type | Description |
FeaturestoreOnlineServingServiceClient |
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.
Name | Description |
settings | FeaturestoreOnlineServingServiceSettings |
Type | Description |
FeaturestoreOnlineServingServiceClient |
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).
Name | Description |
stub | FeaturestoreOnlineServingServiceStub |
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.
Name | Description |
settings | FeaturestoreOnlineServingServiceSettings |
FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceStub stub)
protected FeaturestoreOnlineServingServiceClient(FeaturestoreOnlineServingServiceStub stub)
Name | Description |
stub | FeaturestoreOnlineServingServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = featurestoreOnlineServingServiceClient.getIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future =
featurestoreOnlineServingServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = featurestoreOnlineServingServiceClient.getLocation(request);
}
Name | Description |
request | com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getSettings()
public final FeaturestoreOnlineServingServiceSettings getSettings()
Type | Description |
FeaturestoreOnlineServingServiceSettings |
getStub()
public FeaturestoreOnlineServingServiceStub getStub()
Type | Description |
FeaturestoreOnlineServingServiceStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
Name | Description |
request | com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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;
}
}
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
EntityTypeName entityType =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]");
ReadFeatureValuesResponse response =
featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
}
Name | Description |
entityType | EntityTypeName Required. The resource name of the EntityType for the entity being read.
Value format:
|
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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);
}
Name | Description |
request | ReadFeatureValuesRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
String entityType =
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString();
ReadFeatureValuesResponse response =
featurestoreOnlineServingServiceClient.readFeatureValues(entityType);
}
Name | Description |
entityType | String Required. The resource name of the EntityType for the entity being read.
Value format:
|
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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();
}
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_DENIED
errors.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = featurestoreOnlineServingServiceClient.setIamPolicy(request);
}
Name | Description |
request | com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
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_DENIED
errors.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future =
featurestoreOnlineServingServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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.
}
}
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response =
featurestoreOnlineServingServiceClient.testIamPermissions(request);
}
Name | Description |
request | com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
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 for illustrative purposes only.
// It may require modifications to work in your environment.
try (FeaturestoreOnlineServingServiceClient featurestoreOnlineServingServiceClient =
FeaturestoreOnlineServingServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
featurestoreOnlineServingServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |