Class PolicyBasedRoutingServiceClient (1.6.0)

Version 1.6.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.9
• 1.1.1
• 1.0.0
• 0.5.0

public class PolicyBasedRoutingServiceClient 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]", "[LOCATION]", "[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().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

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

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

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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 Optional. 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 Optional. 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]", "[LOCATION]", "[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]", "[LOCATION]", "[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]", "[LOCATION]", "[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]", "[LOCATION]", "[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]", "[LOCATION]", "[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>

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]", "[LOCATION]", "[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]", "[LOCATION]", "[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]", "[LOCATION]", "[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]", "[LOCATION]", "[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

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>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()