All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.cloud.aiplatform.v1beta1.PersistentResourceServiceClient Maven / Gradle / Ivy

There is a newer version: 3.55.0
Show newest version
/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.aiplatform.v1beta1;

import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.aiplatform.v1beta1.stub.PersistentResourceServiceStub;
import com.google.cloud.aiplatform.v1beta1.stub.PersistentResourceServiceStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * 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: * *

{@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);
 * }
 * }
* *

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: * *

{@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
 * PersistentResourceServiceSettings persistentResourceServiceSettings =
 *     PersistentResourceServiceSettings.newBuilder()
 *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
 *         .build();
 * PersistentResourceServiceClient persistentResourceServiceClient =
 *     PersistentResourceServiceClient.create(persistentResourceServiceSettings);
 * }
* *

To customize the endpoint: * *

{@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
 * 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. */ @BetaApi @Generated("by gapic-generator-java") public class PersistentResourceServiceClient implements BackgroundResource { private final PersistentResourceServiceSettings settings; private final PersistentResourceServiceStub stub; private final OperationsClient operationsClient; /** Constructs an instance of PersistentResourceServiceClient with default settings. */ public static final PersistentResourceServiceClient create() throws IOException { return create(PersistentResourceServiceSettings.newBuilder().build()); } /** * 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. */ public static final PersistentResourceServiceClient create( PersistentResourceServiceSettings settings) throws IOException { return new PersistentResourceServiceClient(settings); } /** * Constructs an instance of PersistentResourceServiceClient, using the given stub for making * calls. This is for advanced usage - prefer using create(PersistentResourceServiceSettings). */ public static final PersistentResourceServiceClient create(PersistentResourceServiceStub stub) { return new PersistentResourceServiceClient(stub); } /** * 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. */ protected PersistentResourceServiceClient(PersistentResourceServiceSettings settings) throws IOException { this.settings = settings; this.stub = ((PersistentResourceServiceStubSettings) settings.getStubSettings()).createStub(); this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); } protected PersistentResourceServiceClient(PersistentResourceServiceStub stub) { this.settings = null; this.stub = stub; this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); } public final PersistentResourceServiceSettings getSettings() { return settings; } public PersistentResourceServiceStub getStub() { return stub; } /** * Returns the OperationsClient that can be used to query the status of a long-running operation * returned by another API method call. */ public final OperationsClient getOperationsClient() { return operationsClient; } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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();
   * }
   * }
* * @param parent Required. The resource name of the Location to create the PersistentResource in. * Format: `projects/{project}/locations/{location}` * @param persistentResource Required. The PersistentResource to create. * @param 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 */ public final OperationFuture createPersistentResourceAsync( LocationName parent, PersistentResource persistentResource, String persistentResourceId) { CreatePersistentResourceRequest request = CreatePersistentResourceRequest.newBuilder() .setParent(parent == null ? null : parent.toString()) .setPersistentResource(persistentResource) .setPersistentResourceId(persistentResourceId) .build(); return createPersistentResourceAsync(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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();
   * }
   * }
* * @param parent Required. The resource name of the Location to create the PersistentResource in. * Format: `projects/{project}/locations/{location}` * @param persistentResource Required. The PersistentResource to create. * @param 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 */ public final OperationFuture createPersistentResourceAsync( String parent, PersistentResource persistentResource, String persistentResourceId) { CreatePersistentResourceRequest request = CreatePersistentResourceRequest.newBuilder() .setParent(parent) .setPersistentResource(persistentResource) .setPersistentResourceId(persistentResourceId) .build(); return createPersistentResourceAsync(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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();
   * }
   * }
* * @param 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 */ public final OperationFuture createPersistentResourceAsync(CreatePersistentResourceRequest request) { return createPersistentResourceOperationCallable().futureCall(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   CreatePersistentResourceRequest request =
   *       CreatePersistentResourceRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPersistentResource(PersistentResource.newBuilder().build())
   *           .setPersistentResourceId("persistentResourceId-2123080768")
   *           .build();
   *   OperationFuture future =
   *       persistentResourceServiceClient
   *           .createPersistentResourceOperationCallable()
   *           .futureCall(request);
   *   // Do something.
   *   PersistentResource response = future.get();
   * }
   * }
*/ public final OperationCallable< CreatePersistentResourceRequest, PersistentResource, CreatePersistentResourceOperationMetadata> createPersistentResourceOperationCallable() { return stub.createPersistentResourceOperationCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Creates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   CreatePersistentResourceRequest request =
   *       CreatePersistentResourceRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPersistentResource(PersistentResource.newBuilder().build())
   *           .setPersistentResourceId("persistentResourceId-2123080768")
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.createPersistentResourceCallable().futureCall(request);
   *   // Do something.
   *   Operation response = future.get();
   * }
   * }
*/ public final UnaryCallable createPersistentResourceCallable() { return stub.createPersistentResourceCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   PersistentResourceName name =
   *       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
   *   PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
   * }
   * }
* * @param 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 */ public final PersistentResource getPersistentResource(PersistentResourceName name) { GetPersistentResourceRequest request = GetPersistentResourceRequest.newBuilder() .setName(name == null ? null : name.toString()) .build(); return getPersistentResource(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   String name =
   *       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]").toString();
   *   PersistentResource response = persistentResourceServiceClient.getPersistentResource(name);
   * }
   * }
* * @param 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 */ public final PersistentResource getPersistentResource(String name) { GetPersistentResourceRequest request = GetPersistentResourceRequest.newBuilder().setName(name).build(); return getPersistentResource(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   GetPersistentResourceRequest request =
   *       GetPersistentResourceRequest.newBuilder()
   *           .setName(
   *               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
   *                   .toString())
   *           .build();
   *   PersistentResource response = persistentResourceServiceClient.getPersistentResource(request);
   * }
   * }
* * @param 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 */ public final PersistentResource getPersistentResource(GetPersistentResourceRequest request) { return getPersistentResourceCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   GetPersistentResourceRequest request =
   *       GetPersistentResourceRequest.newBuilder()
   *           .setName(
   *               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
   *                   .toString())
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.getPersistentResourceCallable().futureCall(request);
   *   // Do something.
   *   PersistentResource response = future.get();
   * }
   * }
*/ public final UnaryCallable getPersistentResourceCallable() { return stub.getPersistentResourceCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists PersistentResources in a Location. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   *   for (PersistentResource element :
   *       persistentResourceServiceClient.listPersistentResources(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
* * @param parent Required. The resource name of the Location to list the PersistentResources from. * Format: `projects/{project}/locations/{location}` * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ public final ListPersistentResourcesPagedResponse listPersistentResources(LocationName parent) { ListPersistentResourcesRequest request = ListPersistentResourcesRequest.newBuilder() .setParent(parent == null ? null : parent.toString()) .build(); return listPersistentResources(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists PersistentResources in a Location. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   *   for (PersistentResource element :
   *       persistentResourceServiceClient.listPersistentResources(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
* * @param parent Required. The resource name of the Location to list the PersistentResources from. * Format: `projects/{project}/locations/{location}` * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ public final ListPersistentResourcesPagedResponse listPersistentResources(String parent) { ListPersistentResourcesRequest request = ListPersistentResourcesRequest.newBuilder().setParent(parent).build(); return listPersistentResources(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists PersistentResources in a Location. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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);
   *   }
   * }
   * }
* * @param 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 */ public final ListPersistentResourcesPagedResponse listPersistentResources( ListPersistentResourcesRequest request) { return listPersistentResourcesPagedCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists PersistentResources in a Location. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   ListPersistentResourcesRequest request =
   *       ListPersistentResourcesRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient
   *           .listPersistentResourcesPagedCallable()
   *           .futureCall(request);
   *   // Do something.
   *   for (PersistentResource element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
*/ public final UnaryCallable listPersistentResourcesPagedCallable() { return stub.listPersistentResourcesPagedCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists PersistentResources in a Location. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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;
   *     }
   *   }
   * }
   * }
*/ public final UnaryCallable listPersistentResourcesCallable() { return stub.listPersistentResourcesCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Deletes a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   PersistentResourceName name =
   *       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]");
   *   persistentResourceServiceClient.deletePersistentResourceAsync(name).get();
   * }
   * }
* * @param name Required. The name of the PersistentResource to be deleted. Format: * `projects/{project}/locations/{location}/persistentResources/{persistent_resource}` * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ public final OperationFuture deletePersistentResourceAsync( PersistentResourceName name) { DeletePersistentResourceRequest request = DeletePersistentResourceRequest.newBuilder() .setName(name == null ? null : name.toString()) .build(); return deletePersistentResourceAsync(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Deletes a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   String name =
   *       PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]").toString();
   *   persistentResourceServiceClient.deletePersistentResourceAsync(name).get();
   * }
   * }
* * @param name Required. The name of the PersistentResource to be deleted. Format: * `projects/{project}/locations/{location}/persistentResources/{persistent_resource}` * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ public final OperationFuture deletePersistentResourceAsync( String name) { DeletePersistentResourceRequest request = DeletePersistentResourceRequest.newBuilder().setName(name).build(); return deletePersistentResourceAsync(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Deletes a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   DeletePersistentResourceRequest request =
   *       DeletePersistentResourceRequest.newBuilder()
   *           .setName(
   *               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
   *                   .toString())
   *           .build();
   *   persistentResourceServiceClient.deletePersistentResourceAsync(request).get();
   * }
   * }
* * @param 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 */ public final OperationFuture deletePersistentResourceAsync( DeletePersistentResourceRequest request) { return deletePersistentResourceOperationCallable().futureCall(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Deletes a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   DeletePersistentResourceRequest request =
   *       DeletePersistentResourceRequest.newBuilder()
   *           .setName(
   *               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
   *                   .toString())
   *           .build();
   *   OperationFuture future =
   *       persistentResourceServiceClient
   *           .deletePersistentResourceOperationCallable()
   *           .futureCall(request);
   *   // Do something.
   *   future.get();
   * }
   * }
*/ public final OperationCallable deletePersistentResourceOperationCallable() { return stub.deletePersistentResourceOperationCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Deletes a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   DeletePersistentResourceRequest request =
   *       DeletePersistentResourceRequest.newBuilder()
   *           .setName(
   *               PersistentResourceName.of("[PROJECT]", "[LOCATION]", "[PERSISTENT_RESOURCE]")
   *                   .toString())
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.deletePersistentResourceCallable().futureCall(request);
   *   // Do something.
   *   future.get();
   * }
   * }
*/ public final UnaryCallable deletePersistentResourceCallable() { return stub.deletePersistentResourceCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Updates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   PersistentResource persistentResource = PersistentResource.newBuilder().build();
   *   FieldMask updateMask = FieldMask.newBuilder().build();
   *   PersistentResource response =
   *       persistentResourceServiceClient
   *           .updatePersistentResourceAsync(persistentResource, updateMask)
   *           .get();
   * }
   * }
* * @param 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}` * @param updateMask Required. Specify the fields to be overwritten in the PersistentResource by * the update method. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ public final OperationFuture updatePersistentResourceAsync(PersistentResource persistentResource, FieldMask updateMask) { UpdatePersistentResourceRequest request = UpdatePersistentResourceRequest.newBuilder() .setPersistentResource(persistentResource) .setUpdateMask(updateMask) .build(); return updatePersistentResourceAsync(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Updates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   UpdatePersistentResourceRequest request =
   *       UpdatePersistentResourceRequest.newBuilder()
   *           .setPersistentResource(PersistentResource.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   PersistentResource response =
   *       persistentResourceServiceClient.updatePersistentResourceAsync(request).get();
   * }
   * }
* * @param 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 */ public final OperationFuture updatePersistentResourceAsync(UpdatePersistentResourceRequest request) { return updatePersistentResourceOperationCallable().futureCall(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Updates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   UpdatePersistentResourceRequest request =
   *       UpdatePersistentResourceRequest.newBuilder()
   *           .setPersistentResource(PersistentResource.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   OperationFuture future =
   *       persistentResourceServiceClient
   *           .updatePersistentResourceOperationCallable()
   *           .futureCall(request);
   *   // Do something.
   *   PersistentResource response = future.get();
   * }
   * }
*/ public final OperationCallable< UpdatePersistentResourceRequest, PersistentResource, UpdatePersistentResourceOperationMetadata> updatePersistentResourceOperationCallable() { return stub.updatePersistentResourceOperationCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Updates a PersistentResource. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   UpdatePersistentResourceRequest request =
   *       UpdatePersistentResourceRequest.newBuilder()
   *           .setPersistentResource(PersistentResource.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.updatePersistentResourceCallable().futureCall(request);
   *   // Do something.
   *   Operation response = future.get();
   * }
   * }
*/ public final UnaryCallable updatePersistentResourceCallable() { return stub.updatePersistentResourceCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists information about the supported locations for this service. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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);
   *   }
   * }
   * }
* * @param 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 */ public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) { return listLocationsPagedCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists information about the supported locations for this service. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   ListLocationsRequest request =
   *       ListLocationsRequest.newBuilder()
   *           .setName("name3373707")
   *           .setFilter("filter-1274492040")
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.listLocationsPagedCallable().futureCall(request);
   *   // Do something.
   *   for (Location element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
*/ public final UnaryCallable listLocationsPagedCallable() { return stub.listLocationsPagedCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Lists information about the supported locations for this service. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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;
   *     }
   *   }
   * }
   * }
*/ public final UnaryCallable listLocationsCallable() { return stub.listLocationsCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets information about a location. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   *   Location response = persistentResourceServiceClient.getLocation(request);
   * }
   * }
* * @param 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 */ public final Location getLocation(GetLocationRequest request) { return getLocationCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets information about a location. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.getLocationCallable().futureCall(request);
   *   // Do something.
   *   Location response = future.get();
   * }
   * }
*/ public final UnaryCallable getLocationCallable() { return stub.getLocationCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Sets the access control policy on the specified resource. Replacesany existing policy. * *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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);
   * }
   * }
* * @param 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 */ public final Policy setIamPolicy(SetIamPolicyRequest request) { return setIamPolicyCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Sets the access control policy on the specified resource. Replacesany existing policy. * *

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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 future =
   *       persistentResourceServiceClient.setIamPolicyCallable().futureCall(request);
   *   // Do something.
   *   Policy response = future.get();
   * }
   * }
*/ public final UnaryCallable setIamPolicyCallable() { return stub.setIamPolicyCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets the access control policy for a resource. Returns an empty policyif the resource exists * and does not have a policy set. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (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);
   * }
   * }
* * @param 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 */ public final Policy getIamPolicy(GetIamPolicyRequest request) { return getIamPolicyCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * Gets the access control policy for a resource. Returns an empty policyif the resource exists * and does not have a policy set. * *

Sample code: * *

{@code
   * // This snippet has been automatically generated and should be regarded as a code template only.
   * // It will require modifications to work:
   * // - It may require correct/in-range values for request initialization.
   * // - It may require specifying regional endpoints when creating the service client as shown in
   * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
   * try (PersistentResourceServiceClient persistentResourceServiceClient =
   *     PersistentResourceServiceClient.create()) {
   *   GetIamPolicyRequest request =
   *       GetIamPolicyRequest.newBuilder()
   *           .setResource(
   *               EndpointName.ofProjectLocationEndpointName(
   *                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
   *                   .toString())
   *           .setOptions(GetPolicyOptions.newBuilder().build())
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.getIamPolicyCallable().futureCall(request);
   *   // Do something.
   *   Policy response = future.get();
   * }
   * }
*/ public final UnaryCallable getIamPolicyCallable() { return stub.getIamPolicyCallable(); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * 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: * *

{@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())
   *           .build();
   *   TestIamPermissionsResponse response =
   *       persistentResourceServiceClient.testIamPermissions(request);
   * }
   * }
* * @param 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 */ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) { return testIamPermissionsCallable().call(request); } // AUTO-GENERATED DOCUMENTATION AND METHOD. /** * 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: * *

{@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())
   *           .build();
   *   ApiFuture future =
   *       persistentResourceServiceClient.testIamPermissionsCallable().futureCall(request);
   *   // Do something.
   *   TestIamPermissionsResponse response = future.get();
   * }
   * }
*/ public final UnaryCallable testIamPermissionsCallable() { return stub.testIamPermissionsCallable(); } @Override public final void close() { stub.close(); } @Override public void shutdown() { stub.shutdown(); } @Override public boolean isShutdown() { return stub.isShutdown(); } @Override public boolean isTerminated() { return stub.isTerminated(); } @Override public void shutdownNow() { stub.shutdownNow(); } @Override public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException { return stub.awaitTermination(duration, unit); } public static class ListPersistentResourcesPagedResponse extends AbstractPagedListResponse< ListPersistentResourcesRequest, ListPersistentResourcesResponse, PersistentResource, ListPersistentResourcesPage, ListPersistentResourcesFixedSizeCollection> { public static ApiFuture createAsync( PageContext< ListPersistentResourcesRequest, ListPersistentResourcesResponse, PersistentResource> context, ApiFuture futureResponse) { ApiFuture futurePage = ListPersistentResourcesPage.createEmptyPage().createPageAsync(context, futureResponse); return ApiFutures.transform( futurePage, input -> new ListPersistentResourcesPagedResponse(input), MoreExecutors.directExecutor()); } private ListPersistentResourcesPagedResponse(ListPersistentResourcesPage page) { super(page, ListPersistentResourcesFixedSizeCollection.createEmptyCollection()); } } public static class ListPersistentResourcesPage extends AbstractPage< ListPersistentResourcesRequest, ListPersistentResourcesResponse, PersistentResource, ListPersistentResourcesPage> { private ListPersistentResourcesPage( PageContext< ListPersistentResourcesRequest, ListPersistentResourcesResponse, PersistentResource> context, ListPersistentResourcesResponse response) { super(context, response); } private static ListPersistentResourcesPage createEmptyPage() { return new ListPersistentResourcesPage(null, null); } @Override protected ListPersistentResourcesPage createPage( PageContext< ListPersistentResourcesRequest, ListPersistentResourcesResponse, PersistentResource> context, ListPersistentResourcesResponse response) { return new ListPersistentResourcesPage(context, response); } @Override public ApiFuture createPageAsync( PageContext< ListPersistentResourcesRequest, ListPersistentResourcesResponse, PersistentResource> context, ApiFuture futureResponse) { return super.createPageAsync(context, futureResponse); } } public static class ListPersistentResourcesFixedSizeCollection extends AbstractFixedSizeCollection< ListPersistentResourcesRequest, ListPersistentResourcesResponse, PersistentResource, ListPersistentResourcesPage, ListPersistentResourcesFixedSizeCollection> { private ListPersistentResourcesFixedSizeCollection( List pages, int collectionSize) { super(pages, collectionSize); } private static ListPersistentResourcesFixedSizeCollection createEmptyCollection() { return new ListPersistentResourcesFixedSizeCollection(null, 0); } @Override protected ListPersistentResourcesFixedSizeCollection createCollection( List pages, int collectionSize) { return new ListPersistentResourcesFixedSizeCollection(pages, collectionSize); } } public static class ListLocationsPagedResponse extends AbstractPagedListResponse< ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage, ListLocationsFixedSizeCollection> { public static ApiFuture createAsync( PageContext context, ApiFuture futureResponse) { ApiFuture futurePage = ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse); return ApiFutures.transform( futurePage, input -> new ListLocationsPagedResponse(input), MoreExecutors.directExecutor()); } private ListLocationsPagedResponse(ListLocationsPage page) { super(page, ListLocationsFixedSizeCollection.createEmptyCollection()); } } public static class ListLocationsPage extends AbstractPage< ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> { private ListLocationsPage( PageContext context, ListLocationsResponse response) { super(context, response); } private static ListLocationsPage createEmptyPage() { return new ListLocationsPage(null, null); } @Override protected ListLocationsPage createPage( PageContext context, ListLocationsResponse response) { return new ListLocationsPage(context, response); } @Override public ApiFuture createPageAsync( PageContext context, ApiFuture futureResponse) { return super.createPageAsync(context, futureResponse); } } public static class ListLocationsFixedSizeCollection extends AbstractFixedSizeCollection< ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage, ListLocationsFixedSizeCollection> { private ListLocationsFixedSizeCollection(List pages, int collectionSize) { super(pages, collectionSize); } private static ListLocationsFixedSizeCollection createEmptyCollection() { return new ListLocationsFixedSizeCollection(null, 0); } @Override protected ListLocationsFixedSizeCollection createCollection( List pages, int collectionSize) { return new ListLocationsFixedSizeCollection(pages, collectionSize); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy