Class PersistentResourceServiceClient (3.29.0)

Version 3.29.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class PersistentResourceServiceClient implements BackgroundResource

Service Description: A service for managing Vertex AI's machine learning PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   PersistentResourceName name =
       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
   PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
 }
 

Note: close() needs to be called on the PersistentResourceServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of PersistentResourceServiceSettings 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
 PersistentResourceServiceSettings persistentResourceServiceSettings =
     PersistentResourceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create(persistentResourceServiceSettings);
 

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
 PersistentResourceServiceSettings persistentResourceServiceSettings =
     PersistentResourceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create(persistentResourceServiceSettings);
 

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

Inheritance

java.lang.Object > PersistentResourceServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final PersistentResourceServiceClient create()

Constructs an instance of PersistentResourceServiceClient with default settings.

Returns
Type	Description
PersistentResourceServiceClient

Exceptions
Type	Description
IOException

create(PersistentResourceServiceSettings settings)

public static final PersistentResourceServiceClient create(PersistentResourceServiceSettings settings)

Constructs an instance of PersistentResourceServiceClient, 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	PersistentResourceServiceSettings

Returns
Type	Description
PersistentResourceServiceClient

Exceptions
Type	Description
IOException

create(PersistentResourceServiceStub stub)

public static final PersistentResourceServiceClient create(PersistentResourceServiceStub stub)

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

Parameter
Name	Description
stub	PersistentResourceServiceStub

Returns
Type	Description
PersistentResourceServiceClient

Constructors

PersistentResourceServiceClient(PersistentResourceServiceSettings settings)

protected PersistentResourceServiceClient(PersistentResourceServiceSettings settings)

Constructs an instance of PersistentResourceServiceClient, 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	PersistentResourceServiceSettings

PersistentResourceServiceClient(PersistentResourceServiceStub stub)

protected PersistentResourceServiceClient(PersistentResourceServiceStub stub)

Parameter
Name	Description
stub	PersistentResourceServiceStub

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

createPersistentResourceAsync(CreatePersistentResourceRequest request)

public final OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata> createPersistentResourceAsync(CreatePersistentResourceRequest request)

Creates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   CreatePersistentResourceRequest request =
       CreatePersistentResourceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPersistentResource(PersistentResource.newBuilder().build())
           .setPersistentResourceId("persistentResourceId-2123080768")
           .build();
   PersistentResource response =
       persistentResourceServiceClient.createPersistentResourceAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata>

createPersistentResourceAsync(LocationName parent, PersistentResource persistentResource, String persistentResourceId)

public final OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata> createPersistentResourceAsync(LocationName parent, PersistentResource persistentResource, String persistentResourceId)

Creates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PersistentResource persistentResource = PersistentResource.newBuilder().build();
   String persistentResourceId = "persistentResourceId-2123080768";
   PersistentResource response =
       persistentResourceServiceClient
           .createPersistentResourceAsync(parent, persistentResource, persistentResourceId)
           .get();
 }
 

Parameters
Name	Description
parent	LocationName Required. The resource name of the Location to create the PersistentResource in. Format: projects/{project}/locations/{location}
persistentResource	PersistentResource Required. The PersistentResource to create.
persistentResourceId	String Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are /^a-z?$/.

Returns
Type	Description
OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata>

createPersistentResourceAsync(String parent, PersistentResource persistentResource, String persistentResourceId)

public final OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata> createPersistentResourceAsync(String parent, PersistentResource persistentResource, String persistentResourceId)

Creates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   PersistentResource persistentResource = PersistentResource.newBuilder().build();
   String persistentResourceId = "persistentResourceId-2123080768";
   PersistentResource response =
       persistentResourceServiceClient
           .createPersistentResourceAsync(parent, persistentResource, persistentResourceId)
           .get();
 }
 

Parameters
Name	Description
parent	String Required. The resource name of the Location to create the PersistentResource in. Format: projects/{project}/locations/{location}
persistentResource	PersistentResource Required. The PersistentResource to create.
persistentResourceId	String Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are /^a-z?$/.

Returns
Type	Description
OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata>

createPersistentResourceCallable()

public final UnaryCallable<CreatePersistentResourceRequest,Operation> createPersistentResourceCallable()

Creates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   CreatePersistentResourceRequest request =
       CreatePersistentResourceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPersistentResource(PersistentResource.newBuilder().build())
           .setPersistentResourceId("persistentResourceId-2123080768")
           .build();
   ApiFuture<Operation> future =
       persistentResourceServiceClient.createPersistentResourceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreatePersistentResourceRequest,Operation>

createPersistentResourceOperationCallable()

public final OperationCallable<CreatePersistentResourceRequest,PersistentResource,CreatePersistentResourceOperationMetadata> createPersistentResourceOperationCallable()

Creates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   CreatePersistentResourceRequest request =
       CreatePersistentResourceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPersistentResource(PersistentResource.newBuilder().build())
           .setPersistentResourceId("persistentResourceId-2123080768")
           .build();
   OperationFuture<PersistentResource, CreatePersistentResourceOperationMetadata> future =
       persistentResourceServiceClient
           .createPersistentResourceOperationCallable()
           .futureCall(request);
   // Do something.
   PersistentResource response = future.get();
 }
 

Returns
Type	Description
OperationCallable<CreatePersistentResourceRequest,PersistentResource,CreatePersistentResourceOperationMetadata>

deletePersistentResourceAsync(DeletePersistentResourceRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deletePersistentResourceAsync(DeletePersistentResourceRequest request)

Deletes a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   DeletePersistentResourceRequest request =
       DeletePersistentResourceRequest.newBuilder()
           .setName(
               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                   .toString())
           .build();
   persistentResourceServiceClient.deletePersistentResourceAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deletePersistentResourceAsync(PersistentResourceName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deletePersistentResourceAsync(PersistentResourceName name)

Deletes a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   PersistentResourceName name =
       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
   persistentResourceServiceClient.deletePersistentResourceAsync(name).get();
 }
 

Parameter
Name	Description
name	PersistentResourceName Required. The name of the PersistentResource to be deleted. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

Returns
Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deletePersistentResourceAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deletePersistentResourceAsync(String name)

Deletes a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   String name =
       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]").toString();
   persistentResourceServiceClient.deletePersistentResourceAsync(name).get();
 }
 

Parameter
Name	Description
name	String Required. The name of the PersistentResource to be deleted. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}

Returns
Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deletePersistentResourceCallable()

public final UnaryCallable<DeletePersistentResourceRequest,Operation> deletePersistentResourceCallable()

Deletes a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   DeletePersistentResourceRequest request =
       DeletePersistentResourceRequest.newBuilder()
           .setName(
               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       persistentResourceServiceClient.deletePersistentResourceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeletePersistentResourceRequest,Operation>

deletePersistentResourceOperationCallable()

public final OperationCallable<DeletePersistentResourceRequest,Empty,DeleteOperationMetadata> deletePersistentResourceOperationCallable()

Deletes a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   DeletePersistentResourceRequest request =
       DeletePersistentResourceRequest.newBuilder()
           .setName(
               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       persistentResourceServiceClient
           .deletePersistentResourceOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
OperationCallable<DeletePersistentResourceRequest,Empty,DeleteOperationMetadata>

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = persistentResourceServiceClient.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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       persistentResourceServiceClient.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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = persistentResourceServiceClient.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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       persistentResourceServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getPersistentResource(GetPersistentResourceRequest request)

public final PersistentResource getPersistentResource(GetPersistentResourceRequest request)

Gets a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   GetPersistentResourceRequest request =
       GetPersistentResourceRequest.newBuilder()
           .setName(
               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                   .toString())
           .build();
   PersistentResource response = persistentResourceServiceClient.getPersistentResource(request);
 }
 

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

Returns
Type	Description
PersistentResource

getPersistentResource(PersistentResourceName name)

public final PersistentResource getPersistentResource(PersistentResourceName name)

Gets a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   PersistentResourceName name =
       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
   PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
 }
 

Parameter
Name	Description
name	PersistentResourceName Required. The name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}

Returns
Type	Description
PersistentResource

getPersistentResource(String name)

public final PersistentResource getPersistentResource(String name)

Gets a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   String name =
       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]").toString();
   PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
 }
 

Parameter
Name	Description
name	String Required. The name of the PersistentResource resource. Format: projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}

Returns
Type	Description
PersistentResource

getPersistentResourceCallable()

public final UnaryCallable<GetPersistentResourceRequest,PersistentResource> getPersistentResourceCallable()

Gets a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   GetPersistentResourceRequest request =
       GetPersistentResourceRequest.newBuilder()
           .setName(
               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
                   .toString())
           .build();
   ApiFuture<PersistentResource> future =
       persistentResourceServiceClient.getPersistentResourceCallable().futureCall(request);
   // Do something.
   PersistentResource response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetPersistentResourceRequest,PersistentResource>

getSettings()

public final PersistentResourceServiceSettings getSettings()

Returns
Type	Description
PersistentResourceServiceSettings

getStub()

public PersistentResourceServiceStub getStub()

Returns
Type	Description
PersistentResourceServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listLocations(ListLocationsRequest request)

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

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

listPersistentResources(ListPersistentResourcesRequest request)

public final PersistentResourceServiceClient.ListPersistentResourcesPagedResponse listPersistentResources(ListPersistentResourcesRequest request)

Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   ListPersistentResourcesRequest request =
       ListPersistentResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (PersistentResource element :
       persistentResourceServiceClient.listPersistentResources(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
PersistentResourceServiceClient.ListPersistentResourcesPagedResponse

listPersistentResources(LocationName parent)

public final PersistentResourceServiceClient.ListPersistentResourcesPagedResponse listPersistentResources(LocationName parent)

Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (PersistentResource element :
       persistentResourceServiceClient.listPersistentResources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	LocationName Required. The resource name of the Location to list the PersistentResources from. Format: projects/{project}/locations/{location}

Returns
Type	Description
PersistentResourceServiceClient.ListPersistentResourcesPagedResponse

listPersistentResources(String parent)

public final PersistentResourceServiceClient.ListPersistentResourcesPagedResponse listPersistentResources(String parent)

Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (PersistentResource element :
       persistentResourceServiceClient.listPersistentResources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The resource name of the Location to list the PersistentResources from. Format: projects/{project}/locations/{location}

Returns
Type	Description
PersistentResourceServiceClient.ListPersistentResourcesPagedResponse

listPersistentResourcesCallable()

public final UnaryCallable<ListPersistentResourcesRequest,ListPersistentResourcesResponse> listPersistentResourcesCallable()

Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   ListPersistentResourcesRequest request =
       ListPersistentResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListPersistentResourcesResponse response =
         persistentResourceServiceClient.listPersistentResourcesCallable().call(request);
     for (PersistentResource element : response.getPersistentResourcesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListPersistentResourcesRequest,ListPersistentResourcesResponse>

listPersistentResourcesPagedCallable()

public final UnaryCallable<ListPersistentResourcesRequest,PersistentResourceServiceClient.ListPersistentResourcesPagedResponse> listPersistentResourcesPagedCallable()

Lists PersistentResources in 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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   ListPersistentResourcesRequest request =
       ListPersistentResourcesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<PersistentResource> future =
       persistentResourceServiceClient
           .listPersistentResourcesPagedCallable()
           .futureCall(request);
   // Do something.
   for (PersistentResource element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListPersistentResourcesRequest,ListPersistentResourcesPagedResponse>

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

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

updatePersistentResourceAsync(PersistentResource persistentResource, FieldMask updateMask)

public final OperationFuture<PersistentResource,UpdatePersistentResourceOperationMetadata> updatePersistentResourceAsync(PersistentResource persistentResource, FieldMask updateMask)

Updates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   PersistentResource persistentResource = PersistentResource.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   PersistentResource response =
       persistentResourceServiceClient
           .updatePersistentResourceAsync(persistentResource, updateMask)
           .get();
 }
 

Parameters
Name	Description
persistentResource	PersistentResource Required. The PersistentResource to update. The PersistentResource's name field is used to identify the PersistentResource to update. Format: projects/{project}/locations/{location}/persistentResources/{persistent_resource}
updateMask	FieldMask Required. Specify the fields to be overwritten in the PersistentResource by the update method.

Returns
Type	Description
OperationFuture<PersistentResource,UpdatePersistentResourceOperationMetadata>

updatePersistentResourceAsync(UpdatePersistentResourceRequest request)

public final OperationFuture<PersistentResource,UpdatePersistentResourceOperationMetadata> updatePersistentResourceAsync(UpdatePersistentResourceRequest request)

Updates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   UpdatePersistentResourceRequest request =
       UpdatePersistentResourceRequest.newBuilder()
           .setPersistentResource(PersistentResource.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   PersistentResource response =
       persistentResourceServiceClient.updatePersistentResourceAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<PersistentResource,UpdatePersistentResourceOperationMetadata>

updatePersistentResourceCallable()

public final UnaryCallable<UpdatePersistentResourceRequest,Operation> updatePersistentResourceCallable()

Updates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   UpdatePersistentResourceRequest request =
       UpdatePersistentResourceRequest.newBuilder()
           .setPersistentResource(PersistentResource.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       persistentResourceServiceClient.updatePersistentResourceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdatePersistentResourceRequest,Operation>

updatePersistentResourceOperationCallable()

public final OperationCallable<UpdatePersistentResourceRequest,PersistentResource,UpdatePersistentResourceOperationMetadata> updatePersistentResourceOperationCallable()

Updates a PersistentResource.

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 (PersistentResourceServiceClient persistentResourceServiceClient =
     PersistentResourceServiceClient.create()) {
   UpdatePersistentResourceRequest request =
       UpdatePersistentResourceRequest.newBuilder()
           .setPersistentResource(PersistentResource.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<PersistentResource, UpdatePersistentResourceOperationMetadata> future =
       persistentResourceServiceClient
           .updatePersistentResourceOperationCallable()
           .futureCall(request);
   // Do something.
   PersistentResource response = future.get();
 }
 

Returns
Type	Description
OperationCallable<UpdatePersistentResourceRequest,PersistentResource,UpdatePersistentResourceOperationMetadata>