Class GenAiCacheServiceClient (3.53.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

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

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

  • setIamPolicy(SetIamPolicyRequest request)

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

  • setIamPolicyCallable()

GetIamPolicy

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

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

  • getIamPolicy(GetIamPolicyRequest request)

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

  • getIamPolicyCallable()

TestIamPermissions

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

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

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

  • testIamPermissions(TestIamPermissionsRequest request)

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

  • testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of 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.

Inheritance

java.lang.Object > GenAiCacheServiceClient

Static Methods

create()

public static final GenAiCacheServiceClient create()

Constructs an instance of GenAiCacheServiceClient with default settings.

Returns
Type Description
GenAiCacheServiceClient
Exceptions
Type Description
IOException

create(GenAiCacheServiceSettings settings)

public static final GenAiCacheServiceClient create(GenAiCacheServiceSettings settings)

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.

Parameter
Name Description
settings GenAiCacheServiceSettings
Returns
Type Description
GenAiCacheServiceClient
Exceptions
Type Description
IOException

create(GenAiCacheServiceStub stub)

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

Parameter
Name Description
stub GenAiCacheServiceStub
Returns
Type Description
GenAiCacheServiceClient

Constructors

GenAiCacheServiceClient(GenAiCacheServiceSettings settings)

protected GenAiCacheServiceClient(GenAiCacheServiceSettings settings)

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.

Parameter
Name Description
settings GenAiCacheServiceSettings

GenAiCacheServiceClient(GenAiCacheServiceStub stub)

protected GenAiCacheServiceClient(GenAiCacheServiceStub stub)
Parameter
Name Description
stub GenAiCacheServiceStub

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

createCachedContent(CreateCachedContentRequest request)

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);
 }
Parameter
Name Description
request CreateCachedContentRequest

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

createCachedContent(LocationName parent, CachedContent cachedContent)

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
Name Description
parent LocationName

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

Required. The cached content to create
Returns
Type Description
CachedContent

createCachedContent(String parent, CachedContent cachedContent)

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
Name Description
parent String

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

Required. The cached content to create
Returns
Type Description
CachedContent

createCachedContentCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<CreateCachedContentRequest,CachedContent>

deleteCachedContent(CachedContentName name)

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);
 }
Parameter
Name Description
name CachedContentName

Required. The resource name referring to the cached content

deleteCachedContent(DeleteCachedContentRequest request)

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);
 }
Parameter
Name Description
request DeleteCachedContentRequest

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

deleteCachedContent(String name)

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);
 }
Parameter
Name Description
name String

Required. The resource name referring to the cached content

deleteCachedContentCallable()

public final UnaryCallable<DeleteCachedContentRequest,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();
 }
Returns
Type Description
UnaryCallable<DeleteCachedContentRequest,Empty>

getCachedContent(CachedContentName name)

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);
 }
Parameter
Name Description
name CachedContentName

Required. The resource name referring to the cached content
Returns
Type Description
CachedContent

getCachedContent(GetCachedContentRequest request)

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);
 }
Parameter
Name Description
request GetCachedContentRequest

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

getCachedContent(String name)

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);
 }
Parameter
Name Description
name String

Required. The resource name referring to the cached content
Returns
Type Description
CachedContent

getCachedContentCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetCachedContentRequest,CachedContent>

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 (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);
 }
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 (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();
 }
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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = genAiCacheServiceClient.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 (GenAiCacheServiceClient genAiCacheServiceClient = GenAiCacheServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       genAiCacheServiceClient.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 GenAiCacheServiceSettings getSettings()
Returns
Type Description
GenAiCacheServiceSettings

getStub()

public GenAiCacheServiceStub getStub()
Returns
Type Description
GenAiCacheServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listCachedContents(ListCachedContentsRequest request)

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);
   }
 }
Parameter
Name Description
request ListCachedContentsRequest

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

listCachedContents(LocationName parent)

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);
   }
 }
Parameter
Name Description
parent LocationName

Required. The parent, which owns this collection of cached contents.
Returns
Type Description
GenAiCacheServiceClient.ListCachedContentsPagedResponse

listCachedContents(String parent)

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);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of cached contents.
Returns
Type Description
GenAiCacheServiceClient.ListCachedContentsPagedResponse

listCachedContentsCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListCachedContentsRequest,ListCachedContentsResponse>

listCachedContentsPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<ListCachedContentsRequest,ListCachedContentsPagedResponse>

listLocations(ListLocationsRequest request)

public final GenAiCacheServiceClient.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 (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);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GenAiCacheServiceClient.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 (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;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<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);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

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 (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);
 }
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 (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();
 }
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 (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);
 }
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 (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();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateCachedContent(CachedContent cachedContent, FieldMask updateMask)

public final CachedContent updateCachedContent(CachedContent cachedContent, 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
Name Description
cachedContent CachedContent

Required. The cached content to update
updateMask FieldMask

Required. The list of fields to update.
Returns
Type Description
CachedContent

updateCachedContent(UpdateCachedContentRequest request)

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);
 }
Parameter
Name Description
request UpdateCachedContentRequest

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

updateCachedContentCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<UpdateCachedContentRequest,CachedContent>