PersistentResourceServiceClient (Google Cloud Vertex AI 3.46.0 API)

java.lang.Object
- com.google.cloud.aiplatform.v1.PersistentResourceServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class PersistentResourceServiceClient
extends Object
implements com.google.api.gax.core.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().

Methods
Method	Description	Method Variants
CreatePersistentResource	Creates a PersistentResource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createPersistentResourceAsync(CreatePersistentResourceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createPersistentResourceAsync(LocationName parent, PersistentResource persistentResource, String persistentResourceId) createPersistentResourceAsync(String parent, PersistentResource persistentResource, String persistentResourceId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createPersistentResourceOperationCallable() createPersistentResourceCallable()
GetPersistentResource	Gets a PersistentResource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getPersistentResource(GetPersistentResourceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPersistentResource(PersistentResourceName name) getPersistentResource(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. getPersistentResourceCallable()
ListPersistentResources	Lists PersistentResources in a Location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPersistentResources(ListPersistentResourcesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPersistentResources(LocationName parent) listPersistentResources(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. listPersistentResourcesPagedCallable() listPersistentResourcesCallable()
DeletePersistentResource	Deletes a PersistentResource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deletePersistentResourceAsync(DeletePersistentResourceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deletePersistentResourceAsync(PersistentResourceName name) deletePersistentResourceAsync(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. deletePersistentResourceOperationCallable() deletePersistentResourceCallable()
UpdatePersistentResource	Updates a PersistentResource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updatePersistentResourceAsync(UpdatePersistentResourceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updatePersistentResourceAsync(PersistentResource persistentResource, 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. updatePersistentResourceOperationCallable() updatePersistentResourceCallable()
RebootPersistentResource	Reboots a PersistentResource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. rebootPersistentResourceAsync(RebootPersistentResourceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. rebootPersistentResourceAsync(PersistentResourceName name) rebootPersistentResourceAsync(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. rebootPersistentResourceOperationCallable() rebootPersistentResourceCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

See the individual methods for example code.

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

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PersistentResourceServiceClient.ListLocationsFixedSizeCollection`
`static class`	`PersistentResourceServiceClient.ListLocationsPage`
`static class`	`PersistentResourceServiceClient.ListLocationsPagedResponse`
`static class`	`PersistentResourceServiceClient.ListPersistentResourcesFixedSizeCollection`
`static class`	`PersistentResourceServiceClient.ListPersistentResourcesPage`
`static class`	`PersistentResourceServiceClient.ListPersistentResourcesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PersistentResourceServiceClient(PersistentResourceServiceSettings settings)` Constructs an instance of PersistentResourceServiceClient, using the given settings.
`protected`	`PersistentResourceServiceClient(PersistentResourceServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static PersistentResourceServiceClient`	`create()` Constructs an instance of PersistentResourceServiceClient with default settings.
`static PersistentResourceServiceClient`	`create(PersistentResourceServiceSettings settings)` Constructs an instance of PersistentResourceServiceClient, using the given settings.
`static PersistentResourceServiceClient`	`create(PersistentResourceServiceStub stub)` Constructs an instance of PersistentResourceServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata>`	`createPersistentResourceAsync(CreatePersistentResourceRequest request)` Creates a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata>`	`createPersistentResourceAsync(LocationName parent, PersistentResource persistentResource, String persistentResourceId)` Creates a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,CreatePersistentResourceOperationMetadata>`	`createPersistentResourceAsync(String parent, PersistentResource persistentResource, String persistentResourceId)` Creates a PersistentResource.
`com.google.api.gax.rpc.UnaryCallable<CreatePersistentResourceRequest,com.google.longrunning.Operation>`	`createPersistentResourceCallable()` Creates a PersistentResource.
`com.google.api.gax.rpc.OperationCallable<CreatePersistentResourceRequest,PersistentResource,CreatePersistentResourceOperationMetadata>`	`createPersistentResourceOperationCallable()` Creates a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deletePersistentResourceAsync(DeletePersistentResourceRequest request)` Deletes a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deletePersistentResourceAsync(PersistentResourceName name)` Deletes a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>`	`deletePersistentResourceAsync(String name)` Deletes a PersistentResource.
`com.google.api.gax.rpc.UnaryCallable<DeletePersistentResourceRequest,com.google.longrunning.Operation>`	`deletePersistentResourceCallable()` Deletes a PersistentResource.
`com.google.api.gax.rpc.OperationCallable<DeletePersistentResourceRequest,com.google.protobuf.Empty,DeleteOperationMetadata>`	`deletePersistentResourceOperationCallable()` Deletes a PersistentResource.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a resource.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`PersistentResource`	`getPersistentResource(GetPersistentResourceRequest request)` Gets a PersistentResource.
`PersistentResource`	`getPersistentResource(PersistentResourceName name)` Gets a PersistentResource.
`PersistentResource`	`getPersistentResource(String name)` Gets a PersistentResource.
`com.google.api.gax.rpc.UnaryCallable<GetPersistentResourceRequest,PersistentResource>`	`getPersistentResourceCallable()` Gets a PersistentResource.
`PersistentResourceServiceSettings`	`getSettings()`
`PersistentResourceServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`PersistentResourceServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,PersistentResourceServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`PersistentResourceServiceClient.ListPersistentResourcesPagedResponse`	`listPersistentResources(ListPersistentResourcesRequest request)` Lists PersistentResources in a Location.
`PersistentResourceServiceClient.ListPersistentResourcesPagedResponse`	`listPersistentResources(LocationName parent)` Lists PersistentResources in a Location.
`PersistentResourceServiceClient.ListPersistentResourcesPagedResponse`	`listPersistentResources(String parent)` Lists PersistentResources in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListPersistentResourcesRequest,ListPersistentResourcesResponse>`	`listPersistentResourcesCallable()` Lists PersistentResources in a Location.
`com.google.api.gax.rpc.UnaryCallable<ListPersistentResourcesRequest,PersistentResourceServiceClient.ListPersistentResourcesPagedResponse>`	`listPersistentResourcesPagedCallable()` Lists PersistentResources in a Location.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,RebootPersistentResourceOperationMetadata>`	`rebootPersistentResourceAsync(PersistentResourceName name)` Reboots a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,RebootPersistentResourceOperationMetadata>`	`rebootPersistentResourceAsync(RebootPersistentResourceRequest request)` Reboots a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,RebootPersistentResourceOperationMetadata>`	`rebootPersistentResourceAsync(String name)` Reboots a PersistentResource.
`com.google.api.gax.rpc.UnaryCallable<RebootPersistentResourceRequest,com.google.longrunning.Operation>`	`rebootPersistentResourceCallable()` Reboots a PersistentResource.
`com.google.api.gax.rpc.OperationCallable<RebootPersistentResourceRequest,PersistentResource,RebootPersistentResourceOperationMetadata>`	`rebootPersistentResourceOperationCallable()` Reboots a PersistentResource.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on the specified resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified resource.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,UpdatePersistentResourceOperationMetadata>`	`updatePersistentResourceAsync(PersistentResource persistentResource, com.google.protobuf.FieldMask updateMask)` Updates a PersistentResource.
`com.google.api.gax.longrunning.OperationFuture<PersistentResource,UpdatePersistentResourceOperationMetadata>`	`updatePersistentResourceAsync(UpdatePersistentResourceRequest request)` Updates a PersistentResource.
`com.google.api.gax.rpc.UnaryCallable<UpdatePersistentResourceRequest,com.google.longrunning.Operation>`	`updatePersistentResourceCallable()` Updates a PersistentResource.
`com.google.api.gax.rpc.OperationCallable<UpdatePersistentResourceRequest,PersistentResource,UpdatePersistentResourceOperationMetadata>`	`updatePersistentResourceOperationCallable()` Updates a PersistentResource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PersistentResourceServiceClient
```
protected PersistentResourceServiceClient(PersistentResourceServiceSettings settings)
                                   throws IOException
```
  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.
  
  Throws:
  
  IOException
- PersistentResourceServiceClient
```
protected PersistentResourceServiceClient(PersistentResourceServiceStub stub)
```

Method Detail

create

public static final PersistentResourceServiceClient create()
                                                    throws IOException

Constructs an instance of PersistentResourceServiceClient with default settings.

Throws:: IOException

create
```
public static final PersistentResourceServiceClient create(PersistentResourceServiceSettings settings)
                                                    throws IOException
```
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.

Throws:

IOException

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

getSettings

public final PersistentResourceServiceSettings getSettings()

getStub

public PersistentResourceServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createPersistentResourceAsync

public final com.google.api.gax.longrunning.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:: parent - Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`; persistentResource - Required. The PersistentResource to create.; persistentResourceId - 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]([a-z0-9-]{0,61}[a-z0-9])?$/`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createPersistentResourceAsync

public final com.google.api.gax.longrunning.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:: parent - Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`; persistentResource - Required. The PersistentResource to create.; persistentResourceId - 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]([a-z0-9-]{0,61}[a-z0-9])?$/`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createPersistentResourceAsync

public final com.google.api.gax.longrunning.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();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createPersistentResourceOperationCallable

public final com.google.api.gax.rpc.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();
 }

createPersistentResourceCallable

public final com.google.api.gax.rpc.UnaryCallable<CreatePersistentResourceRequest,com.google.longrunning.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();
 }

getPersistentResource

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);
 }

Parameters:: name - Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getPersistentResource

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);
 }

Parameters:: name - Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getPersistentResource

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getPersistentResourceCallable

public final com.google.api.gax.rpc.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();
 }