com.google.cloud.networkconnectivity.v1.PolicyBasedRoutingServiceClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-networkconnectivity Show documentation
Google's suite of products that provide enterprise connectivity from your on-premises network or from another cloud provider to your Virtual Private Cloud (VPC) network
The newest version!
/*
 * Copyright 2024 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.networkconnectivity.v1;

import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
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.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.cloud.networkconnectivity.v1.stub.PolicyBasedRoutingServiceStub;
import com.google.cloud.networkconnectivity.v1.stub.PolicyBasedRoutingServiceStubSettings;
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 java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Service Description: Policy-Based Routing allows GCP customers to specify flexibile routing
 * policies for Layer 4 traffic traversing through the connected service.
 *
 * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
 *     PolicyBasedRoutingServiceClient.create()) {
 *   PolicyBasedRouteName name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]");
 *   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(name);
 * }
 * }
 *
 * Note: close() needs to be called on the PolicyBasedRoutingServiceClient object to clean up
 * resources such as threads. In the example above, try-with-resources is used, which automatically
 * calls close().
 *
 * 
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *    
 *      
 *      
 *      
 *    
 *  MethodsMethod Description Method Variants
 ListPolicyBasedRoutes  Lists PolicyBasedRoutes in a given project and location. 
 *      Request object method variants only take one parameter, a request object, which must be constructed before the call.
 *      
 *            listPolicyBasedRoutes(ListPolicyBasedRoutesRequest request)
 *      
 *      "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
 *      
 *            listPolicyBasedRoutes(LocationName parent)
 *           
 listPolicyBasedRoutes(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.
 *      
 *            listPolicyBasedRoutesPagedCallable()
 *           
 listPolicyBasedRoutesCallable()
 *      
 *       
 GetPolicyBasedRoute  Gets details of a single PolicyBasedRoute. 
 *      Request object method variants only take one parameter, a request object, which must be constructed before the call.
 *      
 *            getPolicyBasedRoute(GetPolicyBasedRouteRequest request)
 *      
 *      "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
 *      
 *            getPolicyBasedRoute(PolicyBasedRouteName name)
 *           
 getPolicyBasedRoute(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.
 *      
 *            getPolicyBasedRouteCallable()
 *      
 *       
 CreatePolicyBasedRoute  Creates a new PolicyBasedRoute in a given project and location. 
 *      Request object method variants only take one parameter, a request object, which must be constructed before the call.
 *      
 *            createPolicyBasedRouteAsync(CreatePolicyBasedRouteRequest request)
 *      
 *      Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
 *      
 *            createPolicyBasedRouteAsync(LocationName parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)
 *           
 createPolicyBasedRouteAsync(String parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)
 *      
 *      Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
 *      
 *            createPolicyBasedRouteOperationCallable()
 *           
 createPolicyBasedRouteCallable()
 *      
 *       
 DeletePolicyBasedRoute  Deletes a single PolicyBasedRoute. 
 *      Request object method variants only take one parameter, a request object, which must be constructed before the call.
 *      
 *            deletePolicyBasedRouteAsync(DeletePolicyBasedRouteRequest request)
 *      
 *      Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
 *      
 *            deletePolicyBasedRouteAsync(PolicyBasedRouteName name)
 *           
 deletePolicyBasedRouteAsync(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.
 *      
 *            deletePolicyBasedRouteOperationCallable()
 *           
 deletePolicyBasedRouteCallable()
 *      
 *       
 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
 * PolicyBasedRoutingServiceSettings 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
 * PolicyBasedRoutingServiceSettings policyBasedRoutingServiceSettings =
 *     PolicyBasedRoutingServiceSettings.newBuilder()
 *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
 *         .build();
 * PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
 *     PolicyBasedRoutingServiceClient.create(policyBasedRoutingServiceSettings);
 * }
 *
 * 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
 * PolicyBasedRoutingServiceSettings policyBasedRoutingServiceSettings =
 *     PolicyBasedRoutingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 * PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
 *     PolicyBasedRoutingServiceClient.create(policyBasedRoutingServiceSettings);
 * }
 *
 * Please refer to the GitHub repository's samples for more quickstart code snippets.
 */
@Generated("by gapic-generator-java")
public class PolicyBasedRoutingServiceClient implements BackgroundResource {
  private final PolicyBasedRoutingServiceSettings settings;
  private final PolicyBasedRoutingServiceStub stub;
  private final OperationsClient operationsClient;

  /** Constructs an instance of PolicyBasedRoutingServiceClient with default settings. */
  public static final PolicyBasedRoutingServiceClient create() throws IOException {
    return create(PolicyBasedRoutingServiceSettings.newBuilder().build());
  }

  /**
   * Constructs an instance of PolicyBasedRoutingServiceClient, 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 PolicyBasedRoutingServiceClient create(
      PolicyBasedRoutingServiceSettings settings) throws IOException {
    return new PolicyBasedRoutingServiceClient(settings);
  }

  /**
   * Constructs an instance of PolicyBasedRoutingServiceClient, using the given stub for making
   * calls. This is for advanced usage - prefer using create(PolicyBasedRoutingServiceSettings).
   */
  public static final PolicyBasedRoutingServiceClient create(PolicyBasedRoutingServiceStub stub) {
    return new PolicyBasedRoutingServiceClient(stub);
  }

  /**
   * Constructs an instance of PolicyBasedRoutingServiceClient, 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 PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceSettings settings)
      throws IOException {
    this.settings = settings;
    this.stub = ((PolicyBasedRoutingServiceStubSettings) settings.getStubSettings()).createStub();
    this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
  }

  protected PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceStub stub) {
    this.settings = null;
    this.stub = stub;
    this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
  }

  public final PolicyBasedRoutingServiceSettings getSettings() {
    return settings;
  }

  public PolicyBasedRoutingServiceStub 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.
  /**
   * Lists PolicyBasedRoutes in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   *   for (PolicyBasedRoute element :
   *       policyBasedRoutingServiceClient.listPolicyBasedRoutes(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param parent Required. The parent resource's name.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(LocationName parent) {
    ListPolicyBasedRoutesRequest request =
        ListPolicyBasedRoutesRequest.newBuilder()
            .setParent(parent == null ? null : parent.toString())
            .build();
    return listPolicyBasedRoutes(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists PolicyBasedRoutes in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   *   for (PolicyBasedRoute element :
   *       policyBasedRoutingServiceClient.listPolicyBasedRoutes(parent).iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   *
   * @param parent Required. The parent resource's name.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(String parent) {
    ListPolicyBasedRoutesRequest request =
        ListPolicyBasedRoutesRequest.newBuilder().setParent(parent).build();
    return listPolicyBasedRoutes(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists PolicyBasedRoutes in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   ListPolicyBasedRoutesRequest request =
   *       ListPolicyBasedRoutesRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .setFilter("filter-1274492040")
   *           .setOrderBy("orderBy-1207110587")
   *           .build();
   *   for (PolicyBasedRoute element :
   *       policyBasedRoutingServiceClient.listPolicyBasedRoutes(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 ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(
      ListPolicyBasedRoutesRequest request) {
    return listPolicyBasedRoutesPagedCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists PolicyBasedRoutes in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   ListPolicyBasedRoutesRequest request =
   *       ListPolicyBasedRoutesRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .setFilter("filter-1274492040")
   *           .setOrderBy("orderBy-1207110587")
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.listPolicyBasedRoutesPagedCallable().futureCall(request);
   *   // Do something.
   *   for (PolicyBasedRoute element : future.get().iterateAll()) {
   *     // doThingsWith(element);
   *   }
   * }
   * }
   */
  public final UnaryCallable
      listPolicyBasedRoutesPagedCallable() {
    return stub.listPolicyBasedRoutesPagedCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Lists PolicyBasedRoutes in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   ListPolicyBasedRoutesRequest request =
   *       ListPolicyBasedRoutesRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .setFilter("filter-1274492040")
   *           .setOrderBy("orderBy-1207110587")
   *           .build();
   *   while (true) {
   *     ListPolicyBasedRoutesResponse response =
   *         policyBasedRoutingServiceClient.listPolicyBasedRoutesCallable().call(request);
   *     for (PolicyBasedRoute element : response.getPolicyBasedRoutesList()) {
   *       // doThingsWith(element);
   *     }
   *     String nextPageToken = response.getNextPageToken();
   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
   *       request = request.toBuilder().setPageToken(nextPageToken).build();
   *     } else {
   *       break;
   *     }
   *   }
   * }
   * }
   */
  public final UnaryCallable
      listPolicyBasedRoutesCallable() {
    return stub.listPolicyBasedRoutesCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Gets details of a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   PolicyBasedRouteName name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]");
   *   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(name);
   * }
   * }
   *
   * @param name Required. Name of the PolicyBasedRoute resource to get.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final PolicyBasedRoute getPolicyBasedRoute(PolicyBasedRouteName name) {
    GetPolicyBasedRouteRequest request =
        GetPolicyBasedRouteRequest.newBuilder()
            .setName(name == null ? null : name.toString())
            .build();
    return getPolicyBasedRoute(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Gets details of a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   String name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString();
   *   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(name);
   * }
   * }
   *
   * @param name Required. Name of the PolicyBasedRoute resource to get.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final PolicyBasedRoute getPolicyBasedRoute(String name) {
    GetPolicyBasedRouteRequest request =
        GetPolicyBasedRouteRequest.newBuilder().setName(name).build();
    return getPolicyBasedRoute(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Gets details of a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   GetPolicyBasedRouteRequest request =
   *       GetPolicyBasedRouteRequest.newBuilder()
   *           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
   *           .build();
   *   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(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 PolicyBasedRoute getPolicyBasedRoute(GetPolicyBasedRouteRequest request) {
    return getPolicyBasedRouteCallable().call(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Gets details of a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   GetPolicyBasedRouteRequest request =
   *       GetPolicyBasedRouteRequest.newBuilder()
   *           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.getPolicyBasedRouteCallable().futureCall(request);
   *   // Do something.
   *   PolicyBasedRoute response = future.get();
   * }
   * }
   */
  public final UnaryCallable
      getPolicyBasedRouteCallable() {
    return stub.getPolicyBasedRouteCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a new PolicyBasedRoute in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   *   PolicyBasedRoute policyBasedRoute = PolicyBasedRoute.newBuilder().build();
   *   String policyBasedRouteId = "policyBasedRouteId-18034589";
   *   PolicyBasedRoute response =
   *       policyBasedRoutingServiceClient
   *           .createPolicyBasedRouteAsync(parent, policyBasedRoute, policyBasedRouteId)
   *           .get();
   * }
   * }
   *
   * @param parent Required. The parent resource's name of the PolicyBasedRoute.
   * @param policyBasedRoute Required. Initial values for a new Policy Based Route.
   * @param policyBasedRouteId Required. Unique id for the Policy Based Route to create.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final OperationFuture createPolicyBasedRouteAsync(
      LocationName parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId) {
    CreatePolicyBasedRouteRequest request =
        CreatePolicyBasedRouteRequest.newBuilder()
            .setParent(parent == null ? null : parent.toString())
            .setPolicyBasedRoute(policyBasedRoute)
            .setPolicyBasedRouteId(policyBasedRouteId)
            .build();
    return createPolicyBasedRouteAsync(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a new PolicyBasedRoute in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   *   PolicyBasedRoute policyBasedRoute = PolicyBasedRoute.newBuilder().build();
   *   String policyBasedRouteId = "policyBasedRouteId-18034589";
   *   PolicyBasedRoute response =
   *       policyBasedRoutingServiceClient
   *           .createPolicyBasedRouteAsync(parent, policyBasedRoute, policyBasedRouteId)
   *           .get();
   * }
   * }
   *
   * @param parent Required. The parent resource's name of the PolicyBasedRoute.
   * @param policyBasedRoute Required. Initial values for a new Policy Based Route.
   * @param policyBasedRouteId Required. Unique id for the Policy Based Route to create.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final OperationFuture createPolicyBasedRouteAsync(
      String parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId) {
    CreatePolicyBasedRouteRequest request =
        CreatePolicyBasedRouteRequest.newBuilder()
            .setParent(parent)
            .setPolicyBasedRoute(policyBasedRoute)
            .setPolicyBasedRouteId(policyBasedRouteId)
            .build();
    return createPolicyBasedRouteAsync(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a new PolicyBasedRoute in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   CreatePolicyBasedRouteRequest request =
   *       CreatePolicyBasedRouteRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPolicyBasedRouteId("policyBasedRouteId-18034589")
   *           .setPolicyBasedRoute(PolicyBasedRoute.newBuilder().build())
   *           .setRequestId("requestId693933066")
   *           .build();
   *   PolicyBasedRoute response =
   *       policyBasedRoutingServiceClient.createPolicyBasedRouteAsync(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 createPolicyBasedRouteAsync(
      CreatePolicyBasedRouteRequest request) {
    return createPolicyBasedRouteOperationCallable().futureCall(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a new PolicyBasedRoute in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   CreatePolicyBasedRouteRequest request =
   *       CreatePolicyBasedRouteRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPolicyBasedRouteId("policyBasedRouteId-18034589")
   *           .setPolicyBasedRoute(PolicyBasedRoute.newBuilder().build())
   *           .setRequestId("requestId693933066")
   *           .build();
   *   OperationFuture future =
   *       policyBasedRoutingServiceClient
   *           .createPolicyBasedRouteOperationCallable()
   *           .futureCall(request);
   *   // Do something.
   *   PolicyBasedRoute response = future.get();
   * }
   * }
   */
  public final OperationCallable
      createPolicyBasedRouteOperationCallable() {
    return stub.createPolicyBasedRouteOperationCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Creates a new PolicyBasedRoute in a given project and 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   CreatePolicyBasedRouteRequest request =
   *       CreatePolicyBasedRouteRequest.newBuilder()
   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
   *           .setPolicyBasedRouteId("policyBasedRouteId-18034589")
   *           .setPolicyBasedRoute(PolicyBasedRoute.newBuilder().build())
   *           .setRequestId("requestId693933066")
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.createPolicyBasedRouteCallable().futureCall(request);
   *   // Do something.
   *   Operation response = future.get();
   * }
   * }
   */
  public final UnaryCallable
      createPolicyBasedRouteCallable() {
    return stub.createPolicyBasedRouteCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   PolicyBasedRouteName name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]");
   *   policyBasedRoutingServiceClient.deletePolicyBasedRouteAsync(name).get();
   * }
   * }
   *
   * @param name Required. Name of the PolicyBasedRoute resource to delete.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final OperationFuture deletePolicyBasedRouteAsync(
      PolicyBasedRouteName name) {
    DeletePolicyBasedRouteRequest request =
        DeletePolicyBasedRouteRequest.newBuilder()
            .setName(name == null ? null : name.toString())
            .build();
    return deletePolicyBasedRouteAsync(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   String name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString();
   *   policyBasedRoutingServiceClient.deletePolicyBasedRouteAsync(name).get();
   * }
   * }
   *
   * @param name Required. Name of the PolicyBasedRoute resource to delete.
   * @throws com.google.api.gax.rpc.ApiException if the remote call fails
   */
  public final OperationFuture deletePolicyBasedRouteAsync(String name) {
    DeletePolicyBasedRouteRequest request =
        DeletePolicyBasedRouteRequest.newBuilder().setName(name).build();
    return deletePolicyBasedRouteAsync(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   DeletePolicyBasedRouteRequest request =
   *       DeletePolicyBasedRouteRequest.newBuilder()
   *           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
   *           .setRequestId("requestId693933066")
   *           .build();
   *   policyBasedRoutingServiceClient.deletePolicyBasedRouteAsync(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 deletePolicyBasedRouteAsync(
      DeletePolicyBasedRouteRequest request) {
    return deletePolicyBasedRouteOperationCallable().futureCall(request);
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   DeletePolicyBasedRouteRequest request =
   *       DeletePolicyBasedRouteRequest.newBuilder()
   *           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
   *           .setRequestId("requestId693933066")
   *           .build();
   *   OperationFuture future =
   *       policyBasedRoutingServiceClient
   *           .deletePolicyBasedRouteOperationCallable()
   *           .futureCall(request);
   *   // Do something.
   *   future.get();
   * }
   * }
   */
  public final OperationCallable
      deletePolicyBasedRouteOperationCallable() {
    return stub.deletePolicyBasedRouteOperationCallable();
  }

  // AUTO-GENERATED DOCUMENTATION AND METHOD.
  /**
   * Deletes a single PolicyBasedRoute.
   *
   * 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   DeletePolicyBasedRouteRequest request =
   *       DeletePolicyBasedRouteRequest.newBuilder()
   *           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
   *           .setRequestId("requestId693933066")
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.deletePolicyBasedRouteCallable().futureCall(request);
   *   // Do something.
   *   future.get();
   * }
   * }
   */
  public final UnaryCallable
      deletePolicyBasedRouteCallable() {
    return stub.deletePolicyBasedRouteCallable();
  }

  // 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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   ListLocationsRequest request =
   *       ListLocationsRequest.newBuilder()
   *           .setName("name3373707")
   *           .setFilter("filter-1274492040")
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   for (Location element : policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   ListLocationsRequest request =
   *       ListLocationsRequest.newBuilder()
   *           .setName("name3373707")
   *           .setFilter("filter-1274492040")
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   ListLocationsRequest request =
   *       ListLocationsRequest.newBuilder()
   *           .setName("name3373707")
   *           .setFilter("filter-1274492040")
   *           .setPageSize(883849137)
   *           .setPageToken("pageToken873572522")
   *           .build();
   *   while (true) {
   *     ListLocationsResponse response =
   *         policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   *   Location response = policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   SetIamPolicyRequest request =
   *       SetIamPolicyRequest.newBuilder()
   *           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
   *           .setPolicy(Policy.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   Policy response = policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   SetIamPolicyRequest request =
   *       SetIamPolicyRequest.newBuilder()
   *           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
   *           .setPolicy(Policy.newBuilder().build())
   *           .setUpdateMask(FieldMask.newBuilder().build())
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   GetIamPolicyRequest request =
   *       GetIamPolicyRequest.newBuilder()
   *           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
   *           .setOptions(GetPolicyOptions.newBuilder().build())
   *           .build();
   *   Policy response = policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   GetIamPolicyRequest request =
   *       GetIamPolicyRequest.newBuilder()
   *           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
   *           .setOptions(GetPolicyOptions.newBuilder().build())
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   TestIamPermissionsRequest request =
   *       TestIamPermissionsRequest.newBuilder()
   *           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
   *           .addAllPermissions(new ArrayList())
   *           .build();
   *   TestIamPermissionsResponse response =
   *       policyBasedRoutingServiceClient.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 (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
   *     PolicyBasedRoutingServiceClient.create()) {
   *   TestIamPermissionsRequest request =
   *       TestIamPermissionsRequest.newBuilder()
   *           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
   *           .addAllPermissions(new ArrayList())
   *           .build();
   *   ApiFuture future =
   *       policyBasedRoutingServiceClient.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 ListPolicyBasedRoutesPagedResponse
      extends AbstractPagedListResponse<
          ListPolicyBasedRoutesRequest,
          ListPolicyBasedRoutesResponse,
          PolicyBasedRoute,
          ListPolicyBasedRoutesPage,
          ListPolicyBasedRoutesFixedSizeCollection> {

    public static ApiFuture createAsync(
        PageContext
            context,
        ApiFuture futureResponse) {
      ApiFuture futurePage =
          ListPolicyBasedRoutesPage.createEmptyPage().createPageAsync(context, futureResponse);
      return ApiFutures.transform(
          futurePage,
          input -> new ListPolicyBasedRoutesPagedResponse(input),
          MoreExecutors.directExecutor());
    }

    private ListPolicyBasedRoutesPagedResponse(ListPolicyBasedRoutesPage page) {
      super(page, ListPolicyBasedRoutesFixedSizeCollection.createEmptyCollection());
    }
  }

  public static class ListPolicyBasedRoutesPage
      extends AbstractPage<
          ListPolicyBasedRoutesRequest,
          ListPolicyBasedRoutesResponse,
          PolicyBasedRoute,
          ListPolicyBasedRoutesPage> {

    private ListPolicyBasedRoutesPage(
        PageContext
            context,
        ListPolicyBasedRoutesResponse response) {
      super(context, response);
    }

    private static ListPolicyBasedRoutesPage createEmptyPage() {
      return new ListPolicyBasedRoutesPage(null, null);
    }

    @Override
    protected ListPolicyBasedRoutesPage createPage(
        PageContext
            context,
        ListPolicyBasedRoutesResponse response) {
      return new ListPolicyBasedRoutesPage(context, response);
    }

    @Override
    public ApiFuture createPageAsync(
        PageContext
            context,
        ApiFuture futureResponse) {
      return super.createPageAsync(context, futureResponse);
    }
  }

  public static class ListPolicyBasedRoutesFixedSizeCollection
      extends AbstractFixedSizeCollection<
          ListPolicyBasedRoutesRequest,
          ListPolicyBasedRoutesResponse,
          PolicyBasedRoute,
          ListPolicyBasedRoutesPage,
          ListPolicyBasedRoutesFixedSizeCollection> {

    private ListPolicyBasedRoutesFixedSizeCollection(
        List pages, int collectionSize) {
      super(pages, collectionSize);
    }

    private static ListPolicyBasedRoutesFixedSizeCollection createEmptyCollection() {
      return new ListPolicyBasedRoutesFixedSizeCollection(null, 0);
    }

    @Override
    protected ListPolicyBasedRoutesFixedSizeCollection createCollection(
        List pages, int collectionSize) {
      return new ListPolicyBasedRoutesFixedSizeCollection(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);
    }
  }
}
Method	Description	Method Variants
ListPolicyBasedRoutes	Lists PolicyBasedRoutes in a given project and location.	* Request object method variants only take one parameter, a request object, which must be constructed before the call. * * listPolicyBasedRoutes(ListPolicyBasedRoutesRequest request) * * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. * * listPolicyBasedRoutes(LocationName parent) * listPolicyBasedRoutes(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. * * listPolicyBasedRoutesPagedCallable() * listPolicyBasedRoutesCallable() * *
GetPolicyBasedRoute	Gets details of a single PolicyBasedRoute.	* Request object method variants only take one parameter, a request object, which must be constructed before the call. * * getPolicyBasedRoute(GetPolicyBasedRouteRequest request) * * "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. * * getPolicyBasedRoute(PolicyBasedRouteName name) * getPolicyBasedRoute(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. * * getPolicyBasedRouteCallable() * *
CreatePolicyBasedRoute	Creates a new PolicyBasedRoute in a given project and location.	* Request object method variants only take one parameter, a request object, which must be constructed before the call. * * createPolicyBasedRouteAsync(CreatePolicyBasedRouteRequest request) * * Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. * * createPolicyBasedRouteAsync(LocationName parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId) * createPolicyBasedRouteAsync(String parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId) * * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. * * createPolicyBasedRouteOperationCallable() * createPolicyBasedRouteCallable() * *
DeletePolicyBasedRoute	Deletes a single PolicyBasedRoute.	* Request object method variants only take one parameter, a request object, which must be constructed before the call. * * deletePolicyBasedRouteAsync(DeletePolicyBasedRouteRequest request) * * Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. * * deletePolicyBasedRouteAsync(PolicyBasedRouteName name) * deletePolicyBasedRouteAsync(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. * * deletePolicyBasedRouteOperationCallable() * deletePolicyBasedRouteCallable() * *
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() * *