com.google.cloud.aiplatform.v1

Class GenAiCacheServiceClient

java.lang.Object

com.google.cloud.aiplatform.v1.GenAiCacheServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class GenAiCacheServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing Vertex AI's CachedContent resource.

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CachedContent cachedContent = CachedContent.newBuilder().build();
   CachedContent response = genAiCacheServiceClient.createCachedContent(parent, cachedContent);
 }
 

Note: close() needs to be called on the GenAiCacheServiceClient 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
CreateCachedContent	Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createCachedContent(CreateCachedContentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createCachedContent(LocationName parent, CachedContent cachedContent) createCachedContent(String parent, CachedContent cachedContent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createCachedContentCallable()
GetCachedContent	Gets cached content configurations	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCachedContent(GetCachedContentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCachedContent(CachedContentName name) getCachedContent(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCachedContentCallable()
UpdateCachedContent	Updates cached content configurations	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCachedContent(UpdateCachedContentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCachedContent(CachedContent cachedContent, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCachedContentCallable()
DeleteCachedContent	Deletes cached content	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteCachedContent(DeleteCachedContentRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteCachedContent(CachedContentName name) deleteCachedContent(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteCachedContentCallable()
ListCachedContents	Lists cached contents in a project	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCachedContents(ListCachedContentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCachedContents(LocationName parent) listCachedContents(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCachedContentsPagedCallable() listCachedContentsCallable()
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_DENIED`errors.	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 GenAiCacheServiceSettings 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
 GenAiCacheServiceSettings genAiCacheServiceSettings =
     GenAiCacheServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GenAiCacheServiceClient genAiCacheServiceClient =
     GenAiCacheServiceClient.create(genAiCacheServiceSettings);
 

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
 GenAiCacheServiceSettings genAiCacheServiceSettings =
     GenAiCacheServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 GenAiCacheServiceClient genAiCacheServiceClient =
     GenAiCacheServiceClient.create(genAiCacheServiceSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenAiCacheServiceClient.ListCachedContentsFixedSizeCollection
static class	GenAiCacheServiceClient.ListCachedContentsPage
static class	GenAiCacheServiceClient.ListCachedContentsPagedResponse
static class	GenAiCacheServiceClient.ListLocationsFixedSizeCollection
static class	GenAiCacheServiceClient.ListLocationsPage
static class	GenAiCacheServiceClient.ListLocationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenAiCacheServiceClient(GenAiCacheServiceSettings settings) Constructs an instance of GenAiCacheServiceClient, using the given settings.
protected	GenAiCacheServiceClient(GenAiCacheServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static GenAiCacheServiceClient	create() Constructs an instance of GenAiCacheServiceClient with default settings.
static GenAiCacheServiceClient	create(GenAiCacheServiceSettings settings) Constructs an instance of GenAiCacheServiceClient, using the given settings.
static GenAiCacheServiceClient	create(GenAiCacheServiceStub stub) Constructs an instance of GenAiCacheServiceClient, using the given stub for making calls.
CachedContent	createCachedContent(CreateCachedContentRequest request) Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.
CachedContent	createCachedContent(LocationName parent, CachedContent cachedContent) Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.
CachedContent	createCachedContent(String parent, CachedContent cachedContent) Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.
com.google.api.gax.rpc.UnaryCallable<CreateCachedContentRequest,CachedContent>	createCachedContentCallable() Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.
void	deleteCachedContent(CachedContentName name) Deletes cached content 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { CachedContentName name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]"); genAiCacheServiceClient.deleteCachedContent(name); }
void	deleteCachedContent(DeleteCachedContentRequest request) Deletes cached content 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { DeleteCachedContentRequest request = DeleteCachedContentRequest.newBuilder() .setName( CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString()) .build(); genAiCacheServiceClient.deleteCachedContent(request); }
void	deleteCachedContent(String name) Deletes cached content 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { String name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString(); genAiCacheServiceClient.deleteCachedContent(name); }
com.google.api.gax.rpc.UnaryCallable<DeleteCachedContentRequest,com.google.protobuf.Empty>	deleteCachedContentCallable() Deletes cached content Sample code: {@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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { DeleteCachedContentRequest request = DeleteCachedContentRequest.newBuilder() .setName( CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString()) .build(); ApiFuture future = genAiCacheServiceClient.deleteCachedContentCallable().futureCall(request); // Do something.
CachedContent	getCachedContent(CachedContentName name) Gets cached content configurations 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { CachedContentName name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]"); CachedContent response = genAiCacheServiceClient.getCachedContent(name); }
CachedContent	getCachedContent(GetCachedContentRequest request) Gets cached content configurations 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { GetCachedContentRequest request = GetCachedContentRequest.newBuilder() .setName( CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString()) .build(); CachedContent response = genAiCacheServiceClient.getCachedContent(request); }
CachedContent	getCachedContent(String name) Gets cached content configurations 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { String name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString(); CachedContent response = genAiCacheServiceClient.getCachedContent(name); }
com.google.api.gax.rpc.UnaryCallable<GetCachedContentRequest,CachedContent>	getCachedContentCallable() Gets cached content configurations Sample code: {@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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { GetCachedContentRequest request = GetCachedContentRequest.newBuilder() .setName( CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString()) .build(); ApiFuture future = genAiCacheServiceClient.getCachedContentCallable().futureCall(request); // Do something.
com.google.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicyCallable() Gets the access control policy for a resource.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
GenAiCacheServiceSettings	getSettings()
GenAiCacheServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
GenAiCacheServiceClient.ListCachedContentsPagedResponse	listCachedContents(ListCachedContentsRequest request) Lists cached contents in a project 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { ListCachedContentsRequest request = ListCachedContentsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (CachedContent element : genAiCacheServiceClient.listCachedContents(request).iterateAll()) { // doThingsWith(element); } }
GenAiCacheServiceClient.ListCachedContentsPagedResponse	listCachedContents(LocationName parent) Lists cached contents in a project 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); for (CachedContent element : genAiCacheServiceClient.listCachedContents(parent).iterateAll()) { // doThingsWith(element); } }
GenAiCacheServiceClient.ListCachedContentsPagedResponse	listCachedContents(String parent) Lists cached contents in a project 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString(); for (CachedContent element : genAiCacheServiceClient.listCachedContents(parent).iterateAll()) { // doThingsWith(element); } }
com.google.api.gax.rpc.UnaryCallable<ListCachedContentsRequest,ListCachedContentsResponse>	listCachedContentsCallable() Lists cached contents in a project 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { ListCachedContentsRequest request = ListCachedContentsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListCachedContentsResponse response = genAiCacheServiceClient.listCachedContentsCallable().call(request); for (CachedContent element : response.getCachedContentsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!
com.google.api.gax.rpc.UnaryCallable<ListCachedContentsRequest,GenAiCacheServiceClient.ListCachedContentsPagedResponse>	listCachedContentsPagedCallable() Lists cached contents in a project Sample code: {@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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { ListCachedContentsRequest request = ListCachedContentsRequest.newBuilder() .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture future = genAiCacheServiceClient.listCachedContentsPagedCallable().futureCall(request); // Do something.
GenAiCacheServiceClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>	listLocationsCallable() Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,GenAiCacheServiceClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on the specified resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicyCallable() Sets the access control policy on the specified resource.
void	shutdown()
void	shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsCallable() Returns permissions that a caller has on the specified resource.
CachedContent	updateCachedContent(CachedContent cachedContent, com.google.protobuf.FieldMask updateMask) Updates cached content configurations 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { CachedContent cachedContent = CachedContent.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); CachedContent response = genAiCacheServiceClient.updateCachedContent(cachedContent, updateMask); }
CachedContent	updateCachedContent(UpdateCachedContentRequest request) Updates cached content configurations 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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { UpdateCachedContentRequest request = UpdateCachedContentRequest.newBuilder() .setCachedContent(CachedContent.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); CachedContent response = genAiCacheServiceClient.updateCachedContent(request); }
com.google.api.gax.rpc.UnaryCallable<UpdateCachedContentRequest,CachedContent>	updateCachedContentCallable() Updates cached content configurations Sample code: {@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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) { UpdateCachedContentRequest request = UpdateCachedContentRequest.newBuilder() .setCachedContent(CachedContent.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture future = genAiCacheServiceClient.updateCachedContentCallable().futureCall(request); // Do something.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenAiCacheServiceClient

protected GenAiCacheServiceClient(GenAiCacheServiceSettings settings)
                           throws IOException

Constructs an instance of GenAiCacheServiceClient, 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.

Throws:

IOException

GenAiCacheServiceClient

protected GenAiCacheServiceClient(GenAiCacheServiceStub stub)

Method Detail

create

public static final GenAiCacheServiceClient create()
                                            throws IOException

Constructs an instance of GenAiCacheServiceClient with default settings.

Throws:

IOException

create

public static final GenAiCacheServiceClient create(GenAiCacheServiceSettings settings)
                                            throws IOException

Constructs an instance of GenAiCacheServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final GenAiCacheServiceClient create(GenAiCacheServiceStub stub)

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

getSettings

public final GenAiCacheServiceSettings getSettings()

getStub

public GenAiCacheServiceStub getStub()

createCachedContent

public final CachedContent createCachedContent(LocationName parent,
                                               CachedContent cachedContent)

Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CachedContent cachedContent = CachedContent.newBuilder().build();
   CachedContent response = genAiCacheServiceClient.createCachedContent(parent, cachedContent);
 }
 

Parameters:

parent - Required. The parent resource where the cached content will be created

cachedContent - Required. The cached content to create

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createCachedContent

public final CachedContent createCachedContent(String parent,
                                               CachedContent cachedContent)

Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CachedContent cachedContent = CachedContent.newBuilder().build();
   CachedContent response = genAiCacheServiceClient.createCachedContent(parent, cachedContent);
 }
 

Parameters:

parent - Required. The parent resource where the cached content will be created

cachedContent - Required. The cached content to create

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createCachedContent

public final CachedContent createCachedContent(CreateCachedContentRequest request)

Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   CreateCachedContentRequest request =
       CreateCachedContentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCachedContent(CachedContent.newBuilder().build())
           .build();
   CachedContent response = genAiCacheServiceClient.createCachedContent(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createCachedContentCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateCachedContentRequest,CachedContent> createCachedContentCallable()

Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   CreateCachedContentRequest request =
       CreateCachedContentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCachedContent(CachedContent.newBuilder().build())
           .build();
   ApiFuture<CachedContent> future =
       genAiCacheServiceClient.createCachedContentCallable().futureCall(request);
   // Do something.
   CachedContent response = future.get();
 }
 

getCachedContent

public final CachedContent getCachedContent(CachedContentName name)

Gets cached content configurations

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   CachedContentName name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]");
   CachedContent response = genAiCacheServiceClient.getCachedContent(name);
 }
 

Parameters:

name - Required. The resource name referring to the cached content

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getCachedContent

public final CachedContent getCachedContent(String name)

Gets cached content configurations

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   String name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString();
   CachedContent response = genAiCacheServiceClient.getCachedContent(name);
 }
 

Parameters:

name - Required. The resource name referring to the cached content

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getCachedContent

public final CachedContent getCachedContent(GetCachedContentRequest request)

Gets cached content configurations

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   GetCachedContentRequest request =
       GetCachedContentRequest.newBuilder()
           .setName(
               CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString())
           .build();
   CachedContent response = genAiCacheServiceClient.getCachedContent(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getCachedContentCallable

public final com.google.api.gax.rpc.UnaryCallable<GetCachedContentRequest,CachedContent> getCachedContentCallable()

Gets cached content configurations

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   GetCachedContentRequest request =
       GetCachedContentRequest.newBuilder()
           .setName(
               CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString())
           .build();
   ApiFuture<CachedContent> future =
       genAiCacheServiceClient.getCachedContentCallable().futureCall(request);
   // Do something.
   CachedContent response = future.get();
 }
 

updateCachedContent

public final CachedContent updateCachedContent(CachedContent cachedContent,
                                               com.google.protobuf.FieldMask updateMask)

Updates cached content configurations

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   CachedContent cachedContent = CachedContent.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CachedContent response =
       genAiCacheServiceClient.updateCachedContent(cachedContent, updateMask);
 }
 

Parameters:

cachedContent - Required. The cached content to update

updateMask - Required. The list of fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateCachedContent

public final CachedContent updateCachedContent(UpdateCachedContentRequest request)

Updates cached content configurations

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   UpdateCachedContentRequest request =
       UpdateCachedContentRequest.newBuilder()
           .setCachedContent(CachedContent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   CachedContent response = genAiCacheServiceClient.updateCachedContent(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateCachedContentCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateCachedContentRequest,CachedContent> updateCachedContentCallable()

Updates cached content configurations

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   UpdateCachedContentRequest request =
       UpdateCachedContentRequest.newBuilder()
           .setCachedContent(CachedContent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<CachedContent> future =
       genAiCacheServiceClient.updateCachedContentCallable().futureCall(request);
   // Do something.
   CachedContent response = future.get();
 }
 

deleteCachedContent

public final void deleteCachedContent(CachedContentName name)

Deletes cached content

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   CachedContentName name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]");
   genAiCacheServiceClient.deleteCachedContent(name);
 }
 

Parameters:

name - Required. The resource name referring to the cached content

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteCachedContent

public final void deleteCachedContent(String name)

Deletes cached content

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   String name = CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString();
   genAiCacheServiceClient.deleteCachedContent(name);
 }
 

Parameters:

name - Required. The resource name referring to the cached content

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteCachedContent

public final void deleteCachedContent(DeleteCachedContentRequest request)

Deletes cached content

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   DeleteCachedContentRequest request =
       DeleteCachedContentRequest.newBuilder()
           .setName(
               CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString())
           .build();
   genAiCacheServiceClient.deleteCachedContent(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteCachedContentCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteCachedContentRequest,com.google.protobuf.Empty> deleteCachedContentCallable()

Deletes cached content

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   DeleteCachedContentRequest request =
       DeleteCachedContentRequest.newBuilder()
           .setName(
               CachedContentName.of("[PROJECT]", "[LOCATION]", "[CACHED_CONTENT]").toString())
           .build();
   ApiFuture<Empty> future =
       genAiCacheServiceClient.deleteCachedContentCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

listCachedContents

public final GenAiCacheServiceClient.ListCachedContentsPagedResponse listCachedContents(LocationName parent)

Lists cached contents in a project

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (CachedContent element :
       genAiCacheServiceClient.listCachedContents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent, which owns this collection of cached contents.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listCachedContents

public final GenAiCacheServiceClient.ListCachedContentsPagedResponse listCachedContents(String parent)

Lists cached contents in a project

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (CachedContent element :
       genAiCacheServiceClient.listCachedContents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent, which owns this collection of cached contents.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listCachedContents

public final GenAiCacheServiceClient.ListCachedContentsPagedResponse listCachedContents(ListCachedContentsRequest request)

Lists cached contents in a project

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   ListCachedContentsRequest request =
       ListCachedContentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CachedContent element :
       genAiCacheServiceClient.listCachedContents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listCachedContentsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListCachedContentsRequest,GenAiCacheServiceClient.ListCachedContentsPagedResponse> listCachedContentsPagedCallable()

Lists cached contents in a project

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   ListCachedContentsRequest request =
       ListCachedContentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CachedContent> future =
       genAiCacheServiceClient.listCachedContentsPagedCallable().futureCall(request);
   // Do something.
   for (CachedContent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listCachedContentsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListCachedContentsRequest,ListCachedContentsResponse> listCachedContentsCallable()

Lists cached contents in a project

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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   ListCachedContentsRequest request =
       ListCachedContentsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCachedContentsResponse response =
         genAiCacheServiceClient.listCachedContentsCallable().call(request);
     for (CachedContent element : response.getCachedContentsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

listLocations

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

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listLocationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,GenAiCacheServiceClient.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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       genAiCacheServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listLocationsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         genAiCacheServiceClient.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;
     }
   }
 }
 

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = genAiCacheServiceClient.getLocation(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getLocationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       genAiCacheServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

setIamPolicy

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

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

setIamPolicyCallable

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

getIamPolicy

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

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getIamPolicyCallable

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

testIamPermissions

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

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsCallable

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

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException