Package com.google.cloud.networkconnectivity.v1beta

Class PolicyBasedRoutingServiceClient

java.lang.Object
com.google.cloud.networkconnectivity.v1beta.PolicyBasedRoutingServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class PolicyBasedRoutingServiceClient extends Object implements BackgroundResource
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: 


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

Methods
Method Description Method Variants

ListPolicyBasedRoutes

Lists policy-based routes 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 policy-based route.

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 policy-based route 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 policy-based route.

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.This method can be called in two ways:

* **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the project.

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: 


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


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

  • Constructor Details

    • PolicyBasedRoutingServiceClient

      protected PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • PolicyBasedRoutingServiceClient

      protected PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceStub stub)

  • Method Details

    • create

      public static final PolicyBasedRoutingServiceClient create() throws IOException
      Constructs an instance of PolicyBasedRoutingServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final PolicyBasedRoutingServiceClient create(PolicyBasedRoutingServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final PolicyBasedRoutingServiceSettings getSettings()

    • getStub

      public PolicyBasedRoutingServiceStub getStub()

    • getOperationsClient

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

    • listPolicyBasedRoutes

      public final PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(LocationName parent)
      Lists policy-based routes in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (PolicyBasedRoute element :
       policyBasedRoutingServiceClient.listPolicyBasedRoutes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent resource's name.
      Throws:
      ApiException - if the remote call fails

    • listPolicyBasedRoutes

      public final PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(String parent)
      Lists policy-based routes in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (PolicyBasedRoute element :
       policyBasedRoutingServiceClient.listPolicyBasedRoutes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent resource's name.
      Throws:
      ApiException - if the remote call fails

    • listPolicyBasedRoutes

      public final PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(ListPolicyBasedRoutesRequest request)
      Lists policy-based routes in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listPolicyBasedRoutesPagedCallable

      public final UnaryCallable<ListPolicyBasedRoutesRequest,PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse> listPolicyBasedRoutesPagedCallable()
      Lists policy-based routes in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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<PolicyBasedRoute> future =
       policyBasedRoutingServiceClient.listPolicyBasedRoutesPagedCallable().futureCall(request);
   // Do something.
   for (PolicyBasedRoute element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listPolicyBasedRoutesCallable

      public final UnaryCallable<ListPolicyBasedRoutesRequest,ListPolicyBasedRoutesResponse> listPolicyBasedRoutesCallable()
      Lists policy-based routes in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }

    • getPolicyBasedRoute

      public final PolicyBasedRoute getPolicyBasedRoute(PolicyBasedRouteName name)
      Gets details of a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   PolicyBasedRouteName name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]");
   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(name);
 }
      Parameters:
      name - Required. Name of the PolicyBasedRoute resource to get.
      Throws:
      ApiException - if the remote call fails

    • getPolicyBasedRoute

      public final PolicyBasedRoute getPolicyBasedRoute(String name)
      Gets details of a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   String name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString();
   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(name);
 }
      Parameters:
      name - Required. Name of the PolicyBasedRoute resource to get.
      Throws:
      ApiException - if the remote call fails

    • getPolicyBasedRoute

      public final PolicyBasedRoute getPolicyBasedRoute(GetPolicyBasedRouteRequest request)
      Gets details of a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   GetPolicyBasedRouteRequest request =
       GetPolicyBasedRouteRequest.newBuilder()
           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
           .build();
   PolicyBasedRoute response = policyBasedRoutingServiceClient.getPolicyBasedRoute(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getPolicyBasedRouteCallable

      public final UnaryCallable<GetPolicyBasedRouteRequest,PolicyBasedRoute> getPolicyBasedRouteCallable()
      Gets details of a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   GetPolicyBasedRouteRequest request =
       GetPolicyBasedRouteRequest.newBuilder()
           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
           .build();
   ApiFuture<PolicyBasedRoute> future =
       policyBasedRoutingServiceClient.getPolicyBasedRouteCallable().futureCall(request);
   // Do something.
   PolicyBasedRoute response = future.get();
 }

    • createPolicyBasedRouteAsync

      public final OperationFuture<PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteAsync(LocationName parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)
      Creates a new policy-based route in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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();
 }
      Parameters:
      parent - Required. The parent resource's name of the PolicyBasedRoute.
      policyBasedRoute - Required. Initial values for a new policy-based route.
      policyBasedRouteId - Required. Unique id for the policy-based route to create. Provided by the client when the resource is created. The name must comply with https://google.aip.dev/122#resource-id-segments. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([a-z0-9-]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
      Throws:
      ApiException - if the remote call fails

    • createPolicyBasedRouteAsync

      public final OperationFuture<PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteAsync(String parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)
      Creates a new policy-based route in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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();
 }
      Parameters:
      parent - Required. The parent resource's name of the PolicyBasedRoute.
      policyBasedRoute - Required. Initial values for a new policy-based route.
      policyBasedRouteId - Required. Unique id for the policy-based route to create. Provided by the client when the resource is created. The name must comply with https://google.aip.dev/122#resource-id-segments. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([a-z0-9-]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
      Throws:
      ApiException - if the remote call fails

    • createPolicyBasedRouteAsync

      public final OperationFuture<PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteAsync(CreatePolicyBasedRouteRequest request)
      Creates a new policy-based route in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createPolicyBasedRouteOperationCallable

      public final OperationCallable<CreatePolicyBasedRouteRequest,PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteOperationCallable()
      Creates a new policy-based route in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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<PolicyBasedRoute, OperationMetadata> future =
       policyBasedRoutingServiceClient
           .createPolicyBasedRouteOperationCallable()
           .futureCall(request);
   // Do something.
   PolicyBasedRoute response = future.get();
 }

    • createPolicyBasedRouteCallable

      public final UnaryCallable<CreatePolicyBasedRouteRequest,Operation> createPolicyBasedRouteCallable()
      Creates a new policy-based route in a given project and location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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<Operation> future =
       policyBasedRoutingServiceClient.createPolicyBasedRouteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • deletePolicyBasedRouteAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deletePolicyBasedRouteAsync(PolicyBasedRouteName name)
      Deletes a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   PolicyBasedRouteName name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]");
   policyBasedRoutingServiceClient.deletePolicyBasedRouteAsync(name).get();
 }
      Parameters:
      name - Required. Name of the policy-based route resource to delete.
      Throws:
      ApiException - if the remote call fails

    • deletePolicyBasedRouteAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deletePolicyBasedRouteAsync(String name)
      Deletes a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   String name = PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString();
   policyBasedRoutingServiceClient.deletePolicyBasedRouteAsync(name).get();
 }
      Parameters:
      name - Required. Name of the policy-based route resource to delete.
      Throws:
      ApiException - if the remote call fails

    • deletePolicyBasedRouteAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deletePolicyBasedRouteAsync(DeletePolicyBasedRouteRequest request)
      Deletes a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   DeletePolicyBasedRouteRequest request =
       DeletePolicyBasedRouteRequest.newBuilder()
           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
           .setRequestId("requestId693933066")
           .build();
   policyBasedRoutingServiceClient.deletePolicyBasedRouteAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deletePolicyBasedRouteOperationCallable

      public final OperationCallable<DeletePolicyBasedRouteRequest,com.google.protobuf.Empty,OperationMetadata> deletePolicyBasedRouteOperationCallable()
      Deletes a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   DeletePolicyBasedRouteRequest request =
       DeletePolicyBasedRouteRequest.newBuilder()
           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       policyBasedRoutingServiceClient
           .deletePolicyBasedRouteOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }

    • deletePolicyBasedRouteCallable

      public final UnaryCallable<DeletePolicyBasedRouteRequest,Operation> deletePolicyBasedRouteCallable()
      Deletes a single policy-based route.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   DeletePolicyBasedRouteRequest request =
       DeletePolicyBasedRouteRequest.newBuilder()
           .setName(PolicyBasedRouteName.of("[PROJECT]", "[POLICY_BASED_ROUTE]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       policyBasedRoutingServiceClient.deletePolicyBasedRouteCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • listLocations

      public final PolicyBasedRoutingServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
      Lists information about the supported locations for this service.This method can be called in two ways:

      * **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listLocationsPagedCallable

      public final UnaryCallable<ListLocationsRequest,PolicyBasedRoutingServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
      Lists information about the supported locations for this service.This method can be called in two ways:

      * **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       policyBasedRoutingServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
      Lists information about the supported locations for this service.This method can be called in two ways:

      * **List all public locations:** Use the path `GET /v1/locations`.* **List project-visible locations:** Use the path`GET /v1/projects/{project_id}/locations`. This may include publiclocations as well as private or other locations specifically visibleto the project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }

    • getLocation

      public final Location getLocation(GetLocationRequest request)
      Gets information about a location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = policyBasedRoutingServiceClient.getLocation(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
      Gets information about a location.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       policyBasedRoutingServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

    • setIamPolicy

      public final Policy setIamPolicy(SetIamPolicyRequest request)
      Sets the access control policy on the specified resource. Replacesany existing policy.

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

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • setIamPolicyCallable

      public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
      Sets the access control policy on the specified resource. Replacesany existing policy.

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

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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<Policy> future =
       policyBasedRoutingServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • getIamPolicy

      public final Policy getIamPolicy(GetIamPolicyRequest request)
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getIamPolicyCallable

      public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
      Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       policyBasedRoutingServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

    • testIamPermissions

      public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
      Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

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

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       policyBasedRoutingServiceClient.testIamPermissions(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • testIamPermissionsCallable

      public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
      Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

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

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (PolicyBasedRoutingServiceClient policyBasedRoutingServiceClient =
     PolicyBasedRoutingServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(GroupName.of("[PROJECT]", "[HUB]", "[GROUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       policyBasedRoutingServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException