Class PolicyBasedRoutingServiceClient (1.50.0)

GitHub RepositoryProduct Reference

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

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.

Inheritance

java.lang.Object > PolicyBasedRoutingServiceClient

Static Methods

create()

public static final PolicyBasedRoutingServiceClient create()

Constructs an instance of PolicyBasedRoutingServiceClient with default settings.

Returns
Type Description
PolicyBasedRoutingServiceClient
Exceptions
Type Description
IOException

create(PolicyBasedRoutingServiceSettings settings)

public static final PolicyBasedRoutingServiceClient create(PolicyBasedRoutingServiceSettings settings)

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.

Parameter
Name Description
settings PolicyBasedRoutingServiceSettings
Returns
Type Description
PolicyBasedRoutingServiceClient
Exceptions
Type Description
IOException

create(PolicyBasedRoutingServiceStub stub)

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

Parameter
Name Description
stub PolicyBasedRoutingServiceStub
Returns
Type Description
PolicyBasedRoutingServiceClient

Constructors

PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceSettings settings)

protected PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceSettings settings)

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.

Parameter
Name Description
settings PolicyBasedRoutingServiceSettings

PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceStub stub)

protected PolicyBasedRoutingServiceClient(PolicyBasedRoutingServiceStub stub)
Parameter
Name Description
stub PolicyBasedRoutingServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createPolicyBasedRouteAsync(CreatePolicyBasedRouteRequest request)

public final OperationFuture<PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteAsync(CreatePolicyBasedRouteRequest request)

Creates a new PolicyBasedRoute 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();
 }
 
Parameter
Name Description
request CreatePolicyBasedRouteRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<PolicyBasedRoute,OperationMetadata>

createPolicyBasedRouteAsync(LocationName parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)

public final OperationFuture<PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteAsync(LocationName parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)

Creates a new PolicyBasedRoute 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
Name Description
parent LocationName

Required. The parent resource's name of the PolicyBasedRoute.

policyBasedRoute PolicyBasedRoute

Required. Initial values for a new Policy Based Route.

policyBasedRouteId String

Required. Unique id for the Policy Based Route to create.

Returns
Type Description
OperationFuture<PolicyBasedRoute,OperationMetadata>

createPolicyBasedRouteAsync(String parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)

public final OperationFuture<PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteAsync(String parent, PolicyBasedRoute policyBasedRoute, String policyBasedRouteId)

Creates a new PolicyBasedRoute 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
Name Description
parent String

Required. The parent resource's name of the PolicyBasedRoute.

policyBasedRoute PolicyBasedRoute

Required. Initial values for a new Policy Based Route.

policyBasedRouteId String

Required. Unique id for the Policy Based Route to create.

Returns
Type Description
OperationFuture<PolicyBasedRoute,OperationMetadata>

createPolicyBasedRouteCallable()

public final UnaryCallable<CreatePolicyBasedRouteRequest,Operation> createPolicyBasedRouteCallable()

Creates a new PolicyBasedRoute 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();
 }
 
Returns
Type Description
UnaryCallable<CreatePolicyBasedRouteRequest,Operation>

createPolicyBasedRouteOperationCallable()

public final OperationCallable<CreatePolicyBasedRouteRequest,PolicyBasedRoute,OperationMetadata> createPolicyBasedRouteOperationCallable()

Creates a new PolicyBasedRoute 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();
 }
 
Returns
Type Description
OperationCallable<CreatePolicyBasedRouteRequest,PolicyBasedRoute,OperationMetadata>

deletePolicyBasedRouteAsync(DeletePolicyBasedRouteRequest request)

public final OperationFuture<Empty,OperationMetadata> deletePolicyBasedRouteAsync(DeletePolicyBasedRouteRequest request)

Deletes a single PolicyBasedRoute.

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();
 }
 
Parameter
Name Description
request DeletePolicyBasedRouteRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePolicyBasedRouteAsync(PolicyBasedRouteName name)

public final OperationFuture<Empty,OperationMetadata> deletePolicyBasedRouteAsync(PolicyBasedRouteName name)

Deletes a single PolicyBasedRoute.

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();
 }
 
Parameter
Name Description
name PolicyBasedRouteName

Required. Name of the PolicyBasedRoute resource to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePolicyBasedRouteAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deletePolicyBasedRouteAsync(String name)

Deletes a single PolicyBasedRoute.

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();
 }
 
Parameter
Name Description
name String

Required. Name of the PolicyBasedRoute resource to delete.

Returns
Type Description
OperationFuture<Empty,OperationMetadata>

deletePolicyBasedRouteCallable()

public final UnaryCallable<DeletePolicyBasedRouteRequest,Operation> deletePolicyBasedRouteCallable()

Deletes a single PolicyBasedRoute.

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();
 }
 
Returns
Type Description
UnaryCallable<DeletePolicyBasedRouteRequest,Operation>

deletePolicyBasedRouteOperationCallable()

public final OperationCallable<DeletePolicyBasedRouteRequest,Empty,OperationMetadata> deletePolicyBasedRouteOperationCallable()

Deletes a single PolicyBasedRoute.

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();
 }
 
Returns
Type Description
OperationCallable<DeletePolicyBasedRouteRequest,Empty,OperationMetadata>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


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

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


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

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


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

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


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

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type Description
OperationsClient

getPolicyBasedRoute(GetPolicyBasedRouteRequest request)

public final PolicyBasedRoute getPolicyBasedRoute(GetPolicyBasedRouteRequest request)

Gets details of a single PolicyBasedRoute.

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);
 }
 
Parameter
Name Description
request GetPolicyBasedRouteRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
PolicyBasedRoute

getPolicyBasedRoute(PolicyBasedRouteName name)

public final PolicyBasedRoute getPolicyBasedRoute(PolicyBasedRouteName name)

Gets details of a single PolicyBasedRoute.

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);
 }
 
Parameter
Name Description
name PolicyBasedRouteName

Required. Name of the PolicyBasedRoute resource to get.

Returns
Type Description
PolicyBasedRoute

getPolicyBasedRoute(String name)

public final PolicyBasedRoute getPolicyBasedRoute(String name)

Gets details of a single PolicyBasedRoute.

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);
 }
 
Parameter
Name Description
name String

Required. Name of the PolicyBasedRoute resource to get.

Returns
Type Description
PolicyBasedRoute

getPolicyBasedRouteCallable()

public final UnaryCallable<GetPolicyBasedRouteRequest,PolicyBasedRoute> getPolicyBasedRouteCallable()

Gets details of a single PolicyBasedRoute.

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();
 }
 
Returns
Type Description
UnaryCallable<GetPolicyBasedRouteRequest,PolicyBasedRoute>

getSettings()

public final PolicyBasedRoutingServiceSettings getSettings()
Returns
Type Description
PolicyBasedRoutingServiceSettings

getStub()

public PolicyBasedRoutingServiceStub getStub()
Returns
Type Description
PolicyBasedRoutingServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final PolicyBasedRoutingServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


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

The request object containing all of the parameters for the API call.

Returns
Type Description
PolicyBasedRoutingServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


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

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,PolicyBasedRoutingServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


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

listPolicyBasedRoutes(ListPolicyBasedRoutesRequest request)

public final PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(ListPolicyBasedRoutesRequest request)

Lists PolicyBasedRoutes 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);
   }
 }
 
Parameter
Name Description
request ListPolicyBasedRoutesRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse

listPolicyBasedRoutes(LocationName parent)

public final PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(LocationName parent)

Lists PolicyBasedRoutes 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);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The parent resource's name.

Returns
Type Description
PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse

listPolicyBasedRoutes(String parent)

public final PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse listPolicyBasedRoutes(String parent)

Lists PolicyBasedRoutes 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);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent resource's name.

Returns
Type Description
PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse

listPolicyBasedRoutesCallable()

public final UnaryCallable<ListPolicyBasedRoutesRequest,ListPolicyBasedRoutesResponse> listPolicyBasedRoutesCallable()

Lists PolicyBasedRoutes 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;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListPolicyBasedRoutesRequest,ListPolicyBasedRoutesResponse>

listPolicyBasedRoutesPagedCallable()

public final UnaryCallable<ListPolicyBasedRoutesRequest,PolicyBasedRoutingServiceClient.ListPolicyBasedRoutesPagedResponse> listPolicyBasedRoutesPagedCallable()

Lists PolicyBasedRoutes 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);
   }
 }
 
Returns
Type Description
UnaryCallable<ListPolicyBasedRoutesRequest,ListPolicyBasedRoutesPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


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

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

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

Sample code:


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

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

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

Sample code:


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