Class FeatureOnlineStoreServiceClient (3.31.0)

Version 3.31.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 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

GitHub Repository

Product Reference

REST Documentation

RPC Documentation

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   FeatureViewName featureView =
       FeatureViewName.of("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]");
   String id = "id3355";
   FetchFeatureValuesResponse response =
       featureOnlineStoreServiceClient.fetchFeatureValues(featureView, id);
 }
 

Note: close() needs to be called on the FeatureOnlineStoreServiceClient 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 FeatureOnlineStoreServiceSettings 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
 FeatureOnlineStoreServiceSettings featureOnlineStoreServiceSettings =
     FeatureOnlineStoreServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create(featureOnlineStoreServiceSettings);
 

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
 FeatureOnlineStoreServiceSettings featureOnlineStoreServiceSettings =
     FeatureOnlineStoreServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create(featureOnlineStoreServiceSettings);
 

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

Inheritance

java.lang.Object > FeatureOnlineStoreServiceClient

Static Methods

create()

public static final FeatureOnlineStoreServiceClient create()

Constructs an instance of FeatureOnlineStoreServiceClient with default settings.

Returns
Type	Description
FeatureOnlineStoreServiceClient

Exceptions
Type	Description
IOException

create(FeatureOnlineStoreServiceSettings settings)

public static final FeatureOnlineStoreServiceClient create(FeatureOnlineStoreServiceSettings settings)

Constructs an instance of FeatureOnlineStoreServiceClient, 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	FeatureOnlineStoreServiceSettings

Returns
Type	Description
FeatureOnlineStoreServiceClient

Exceptions
Type	Description
IOException

create(FeatureOnlineStoreServiceStub stub)

public static final FeatureOnlineStoreServiceClient create(FeatureOnlineStoreServiceStub stub)

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

Parameter
Name	Description
stub	FeatureOnlineStoreServiceStub

Returns
Type	Description
FeatureOnlineStoreServiceClient

Constructors

FeatureOnlineStoreServiceClient(FeatureOnlineStoreServiceSettings settings)

protected FeatureOnlineStoreServiceClient(FeatureOnlineStoreServiceSettings settings)

Constructs an instance of FeatureOnlineStoreServiceClient, 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	FeatureOnlineStoreServiceSettings

FeatureOnlineStoreServiceClient(FeatureOnlineStoreServiceStub stub)

protected FeatureOnlineStoreServiceClient(FeatureOnlineStoreServiceStub stub)

Parameter
Name	Description
stub	FeatureOnlineStoreServiceStub

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

fetchFeatureValues(FeatureViewName featureView, String id)

public final FetchFeatureValuesResponse fetchFeatureValues(FeatureViewName featureView, String id)

Fetch feature values under a FeatureView.

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   FeatureViewName featureView =
       FeatureViewName.of("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]");
   String id = "id3355";
   FetchFeatureValuesResponse response =
       featureOnlineStoreServiceClient.fetchFeatureValues(featureView, id);
 }
 

Parameters
Name	Description
featureView	FeatureViewName Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
id	String Simple ID. The whole string will be used as is to identify Entity to fetch feature values for.

Returns
Type	Description
FetchFeatureValuesResponse

fetchFeatureValues(FetchFeatureValuesRequest request)

public final FetchFeatureValuesResponse fetchFeatureValues(FetchFeatureValuesRequest request)

Fetch feature values under a FeatureView.

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   FetchFeatureValuesRequest request =
       FetchFeatureValuesRequest.newBuilder()
           .setFeatureView(
               FeatureViewName.of(
                       "[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]")
                   .toString())
           .build();
   FetchFeatureValuesResponse response =
       featureOnlineStoreServiceClient.fetchFeatureValues(request);
 }
 

Parameter
Name	Description
request	FetchFeatureValuesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
FetchFeatureValuesResponse

fetchFeatureValues(String featureView, String id)

public final FetchFeatureValuesResponse fetchFeatureValues(String featureView, String id)

Fetch feature values under a FeatureView.

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   String featureView =
       FeatureViewName.of("[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]")
           .toString();
   String id = "id3355";
   FetchFeatureValuesResponse response =
       featureOnlineStoreServiceClient.fetchFeatureValues(featureView, id);
 }
 

Parameters
Name	Description
featureView	String Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}
id	String Simple ID. The whole string will be used as is to identify Entity to fetch feature values for.

Returns
Type	Description
FetchFeatureValuesResponse

fetchFeatureValuesCallable()

public final UnaryCallable<FetchFeatureValuesRequest,FetchFeatureValuesResponse> fetchFeatureValuesCallable()

Fetch feature values under a FeatureView.

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   FetchFeatureValuesRequest request =
       FetchFeatureValuesRequest.newBuilder()
           .setFeatureView(
               FeatureViewName.of(
                       "[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]")
                   .toString())
           .build();
   ApiFuture<FetchFeatureValuesResponse> future =
       featureOnlineStoreServiceClient.fetchFeatureValuesCallable().futureCall(request);
   // Do something.
   FetchFeatureValuesResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<FetchFeatureValuesRequest,FetchFeatureValuesResponse>

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = featureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       featureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = featureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       featureOnlineStoreServiceClient.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 FeatureOnlineStoreServiceSettings getSettings()

Returns
Type	Description
FeatureOnlineStoreServiceSettings

getStub()

public FeatureOnlineStoreServiceStub getStub()

Returns
Type	Description
FeatureOnlineStoreServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listLocations(ListLocationsRequest request)

public final FeatureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : featureOnlineStoreServiceClient.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
FeatureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         featureOnlineStoreServiceClient.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,FeatureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       featureOnlineStoreServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

searchNearestEntities(SearchNearestEntitiesRequest request)

public final SearchNearestEntitiesResponse searchNearestEntities(SearchNearestEntitiesRequest request)

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   SearchNearestEntitiesRequest request =
       SearchNearestEntitiesRequest.newBuilder()
           .setFeatureView(
               FeatureViewName.of(
                       "[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]")
                   .toString())
           .setQuery(NearestNeighborQuery.newBuilder().build())
           .setReturnFullEntity(true)
           .build();
   SearchNearestEntitiesResponse response =
       featureOnlineStoreServiceClient.searchNearestEntities(request);
 }
 

Parameter
Name	Description
request	SearchNearestEntitiesRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
SearchNearestEntitiesResponse

searchNearestEntitiesCallable()

public final UnaryCallable<SearchNearestEntitiesRequest,SearchNearestEntitiesResponse> searchNearestEntitiesCallable()

Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   SearchNearestEntitiesRequest request =
       SearchNearestEntitiesRequest.newBuilder()
           .setFeatureView(
               FeatureViewName.of(
                       "[PROJECT]", "[LOCATION]", "[FEATURE_ONLINE_STORE]", "[FEATURE_VIEW]")
                   .toString())
           .setQuery(NearestNeighborQuery.newBuilder().build())
           .setReturnFullEntity(true)
           .build();
   ApiFuture<SearchNearestEntitiesResponse> future =
       featureOnlineStoreServiceClient.searchNearestEntitiesCallable().futureCall(request);
   // Do something.
   SearchNearestEntitiesResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SearchNearestEntitiesRequest,SearchNearestEntitiesResponse>

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = featureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       featureOnlineStoreServiceClient.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()

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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       featureOnlineStoreServiceClient.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 (FeatureOnlineStoreServiceClient featureOnlineStoreServiceClient =
     FeatureOnlineStoreServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       featureOnlineStoreServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>