Class RoutersClient (1.64.0)

GitHub RepositoryProduct Reference

Service Description: The Routers API.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   Router response = routersClient.get(project, region, router);
 }

Note: close() needs to be called on the RoutersClient 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

AggregatedList

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregatedList(AggregatedListRoutersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Delete

Deletes the specified Router resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteRouterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String region, String router)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

Get

Returns the specified Router resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetRouterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String region, String router)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

GetNatIpInfo

Retrieves runtime NAT IP information.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNatIpInfo(GetNatIpInfoRouterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNatIpInfo(String project, String region, String router)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNatIpInfoCallable()

GetNatMappingInfo

Retrieves runtime Nat mapping information of VM endpoints.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getNatMappingInfo(GetNatMappingInfoRoutersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getNatMappingInfo(String project, String region, String router)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getNatMappingInfoPagedCallable()

  • getNatMappingInfoCallable()

GetRouterStatus

Retrieves runtime information of the specified router.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getRouterStatus(GetRouterStatusRouterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getRouterStatus(String project, String region, String router)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getRouterStatusCallable()

Insert

Creates a Router resource in the specified project and region using the data included in the request.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • insertAsync(InsertRouterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, String region, Router routerResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

Retrieves a list of Router resources available to the specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListRoutersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project, String region)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

Patch

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • patchAsync(PatchRouterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • patchAsync(String project, String region, String router, Router routerResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • patchOperationCallable()

  • patchCallable()

Preview

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • preview(PreviewRouterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • preview(String project, String region, String router, Router routerResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • previewCallable()

Update

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAsync(UpdateRouterRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateAsync(String project, String region, String router, Router routerResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateOperationCallable()

  • updateCallable()

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 RoutersSettings 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
 RoutersSettings routersSettings =
     RoutersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RoutersClient routersClient = RoutersClient.create(routersSettings);

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
 RoutersSettings routersSettings = RoutersSettings.newBuilder().setEndpoint(myEndpoint).build();
 RoutersClient routersClient = RoutersClient.create(routersSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > RoutersClient

Static Methods

create()

public static final RoutersClient create()

Constructs an instance of RoutersClient with default settings.

Returns
Type Description
RoutersClient
Exceptions
Type Description
IOException

create(RoutersSettings settings)

public static final RoutersClient create(RoutersSettings settings)

Constructs an instance of RoutersClient, 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 RoutersSettings
Returns
Type Description
RoutersClient
Exceptions
Type Description
IOException

create(RoutersStub stub)

public static final RoutersClient create(RoutersStub stub)

Constructs an instance of RoutersClient, using the given stub for making calls. This is for advanced usage - prefer using create(RoutersSettings).

Parameter
Name Description
stub RoutersStub
Returns
Type Description
RoutersClient

Constructors

RoutersClient(RoutersSettings settings)

protected RoutersClient(RoutersSettings settings)

Constructs an instance of RoutersClient, 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 RoutersSettings

RoutersClient(RoutersStub stub)

protected RoutersClient(RoutersStub stub)
Parameter
Name Description
stub RoutersStub

Methods

aggregatedList(AggregatedListRoutersRequest request)

public final RoutersClient.AggregatedListPagedResponse aggregatedList(AggregatedListRoutersRequest request)

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (RoutersClient routersClient = RoutersClient.create()) {
   AggregatedListRoutersRequest request =
       AggregatedListRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, RoutersScopedList> element :
       routersClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListRoutersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RoutersClient.AggregatedListPagedResponse

aggregatedList(String project)

public final RoutersClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, RoutersScopedList> element :
       routersClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
RoutersClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListRoutersRequest,RouterAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (RoutersClient routersClient = RoutersClient.create()) {
   AggregatedListRoutersRequest request =
       AggregatedListRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     RouterAggregatedList response = routersClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, RoutersScopedList> element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListRoutersRequest,RouterAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListRoutersRequest,RoutersClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (RoutersClient routersClient = RoutersClient.create()) {
   AggregatedListRoutersRequest request =
       AggregatedListRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, RoutersScopedList>> future =
       routersClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, RoutersScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListRoutersRequest,AggregatedListPagedResponse>

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

deleteAsync(DeleteRouterRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRouterRequest request)

Deletes the specified Router resource.

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 (RoutersClient routersClient = RoutersClient.create()) {
   DeleteRouterRequest request =
       DeleteRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .build();
   Operation response = routersClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String router)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String router)

Deletes the specified Router resource.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   Operation response = routersClient.deleteAsync(project, region, router).get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRouterRequest,Operation> deleteCallable()

Deletes the specified Router resource.

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 (RoutersClient routersClient = RoutersClient.create()) {
   DeleteRouterRequest request =
       DeleteRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .build();
   ApiFuture<Operation> future = routersClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteRouterRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteRouterRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified Router resource.

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 (RoutersClient routersClient = RoutersClient.create()) {
   DeleteRouterRequest request =
       DeleteRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .build();
   OperationFuture<Operation, Operation> future =
       routersClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteRouterRequest,Operation,Operation>

get(GetRouterRequest request)

public final Router get(GetRouterRequest request)

Returns the specified Router resource.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetRouterRequest request =
       GetRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   Router response = routersClient.get(request);
 }
Parameter
Name Description
request GetRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Router

get(String project, String region, String router)

public final Router get(String project, String region, String router)

Returns the specified Router resource.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   Router response = routersClient.get(project, region, router);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to return.
Returns
Type Description
Router

getCallable()

public final UnaryCallable<GetRouterRequest,Router> getCallable()

Returns the specified Router resource.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetRouterRequest request =
       GetRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   ApiFuture<Router> future = routersClient.getCallable().futureCall(request);
   // Do something.
   Router response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRouterRequest,Router>

getNatIpInfo(GetNatIpInfoRouterRequest request)

public final NatIpInfoResponse getNatIpInfo(GetNatIpInfoRouterRequest request)

Retrieves runtime NAT IP information.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetNatIpInfoRouterRequest request =
       GetNatIpInfoRouterRequest.newBuilder()
           .setNatName("natName1727733580")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   NatIpInfoResponse response = routersClient.getNatIpInfo(request);
 }
Parameter
Name Description
request GetNatIpInfoRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
NatIpInfoResponse

getNatIpInfo(String project, String region, String router)

public final NatIpInfoResponse getNatIpInfo(String project, String region, String router)

Retrieves runtime NAT IP information.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   NatIpInfoResponse response = routersClient.getNatIpInfo(project, region, router);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.
Returns
Type Description
NatIpInfoResponse

getNatIpInfoCallable()

public final UnaryCallable<GetNatIpInfoRouterRequest,NatIpInfoResponse> getNatIpInfoCallable()

Retrieves runtime NAT IP information.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetNatIpInfoRouterRequest request =
       GetNatIpInfoRouterRequest.newBuilder()
           .setNatName("natName1727733580")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   ApiFuture<NatIpInfoResponse> future =
       routersClient.getNatIpInfoCallable().futureCall(request);
   // Do something.
   NatIpInfoResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<GetNatIpInfoRouterRequest,NatIpInfoResponse>

getNatMappingInfo(GetNatMappingInfoRoutersRequest request)

public final RoutersClient.GetNatMappingInfoPagedResponse getNatMappingInfo(GetNatMappingInfoRoutersRequest request)

Retrieves runtime Nat mapping information of VM endpoints.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetNatMappingInfoRoutersRequest request =
       GetNatMappingInfoRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setNatName("natName1727733580")
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .setRouter("router-925132983")
           .build();
   for (VmEndpointNatMappings element : routersClient.getNatMappingInfo(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request GetNatMappingInfoRoutersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RoutersClient.GetNatMappingInfoPagedResponse

getNatMappingInfo(String project, String region, String router)

public final RoutersClient.GetNatMappingInfoPagedResponse getNatMappingInfo(String project, String region, String router)

Retrieves runtime Nat mapping information of VM endpoints.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   for (VmEndpointNatMappings element :
       routersClient.getNatMappingInfo(project, region, router).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to query for Nat Mapping information of VM endpoints.
Returns
Type Description
RoutersClient.GetNatMappingInfoPagedResponse

getNatMappingInfoCallable()

public final UnaryCallable<GetNatMappingInfoRoutersRequest,VmEndpointNatMappingsList> getNatMappingInfoCallable()

Retrieves runtime Nat mapping information of VM endpoints.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetNatMappingInfoRoutersRequest request =
       GetNatMappingInfoRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setNatName("natName1727733580")
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .setRouter("router-925132983")
           .build();
   while (true) {
     VmEndpointNatMappingsList response =
         routersClient.getNatMappingInfoCallable().call(request);
     for (VmEndpointNatMappings element : response.getResultList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<GetNatMappingInfoRoutersRequest,VmEndpointNatMappingsList>

getNatMappingInfoPagedCallable()

public final UnaryCallable<GetNatMappingInfoRoutersRequest,RoutersClient.GetNatMappingInfoPagedResponse> getNatMappingInfoPagedCallable()

Retrieves runtime Nat mapping information of VM endpoints.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetNatMappingInfoRoutersRequest request =
       GetNatMappingInfoRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setNatName("natName1727733580")
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .setRouter("router-925132983")
           .build();
   ApiFuture<VmEndpointNatMappings> future =
       routersClient.getNatMappingInfoPagedCallable().futureCall(request);
   // Do something.
   for (VmEndpointNatMappings element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<GetNatMappingInfoRoutersRequest,GetNatMappingInfoPagedResponse>

getRouterStatus(GetRouterStatusRouterRequest request)

public final RouterStatusResponse getRouterStatus(GetRouterStatusRouterRequest request)

Retrieves runtime information of the specified router.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetRouterStatusRouterRequest request =
       GetRouterStatusRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   RouterStatusResponse response = routersClient.getRouterStatus(request);
 }
Parameter
Name Description
request GetRouterStatusRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RouterStatusResponse

getRouterStatus(String project, String region, String router)

public final RouterStatusResponse getRouterStatus(String project, String region, String router)

Retrieves runtime information of the specified router.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   RouterStatusResponse response = routersClient.getRouterStatus(project, region, router);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to query.
Returns
Type Description
RouterStatusResponse

getRouterStatusCallable()

public final UnaryCallable<GetRouterStatusRouterRequest,RouterStatusResponse> getRouterStatusCallable()

Retrieves runtime information of the specified router.

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 (RoutersClient routersClient = RoutersClient.create()) {
   GetRouterStatusRouterRequest request =
       GetRouterStatusRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   ApiFuture<RouterStatusResponse> future =
       routersClient.getRouterStatusCallable().futureCall(request);
   // Do something.
   RouterStatusResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<GetRouterStatusRouterRequest,RouterStatusResponse>

getSettings()

public final RoutersSettings getSettings()
Returns
Type Description
RoutersSettings

getStub()

public RoutersStub getStub()
Returns
Type Description
RoutersStub

insertAsync(InsertRouterRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRouterRequest request)

Creates a Router resource in the specified project and region using the data included in the request.

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 (RoutersClient routersClient = RoutersClient.create()) {
   InsertRouterRequest request =
       InsertRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouterResource(Router.newBuilder().build())
           .build();
   Operation response = routersClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, Router routerResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, Router routerResource)

Creates a Router resource in the specified project and region using the data included in the request.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   Router routerResource = Router.newBuilder().build();
   Operation response = routersClient.insertAsync(project, region, routerResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
routerResource Router

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRouterRequest,Operation> insertCallable()

Creates a Router resource in the specified project and region using the data included in the request.

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 (RoutersClient routersClient = RoutersClient.create()) {
   InsertRouterRequest request =
       InsertRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouterResource(Router.newBuilder().build())
           .build();
   ApiFuture<Operation> future = routersClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertRouterRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertRouterRequest,Operation,Operation> insertOperationCallable()

Creates a Router resource in the specified project and region using the data included in the request.

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 (RoutersClient routersClient = RoutersClient.create()) {
   InsertRouterRequest request =
       InsertRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouterResource(Router.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       routersClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertRouterRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListRoutersRequest request)

public final RoutersClient.ListPagedResponse list(ListRoutersRequest request)

Retrieves a list of Router resources available to the specified 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 (RoutersClient routersClient = RoutersClient.create()) {
   ListRoutersRequest request =
       ListRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (Router element : routersClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListRoutersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RoutersClient.ListPagedResponse

list(String project, String region)

public final RoutersClient.ListPagedResponse list(String project, String region)

Retrieves a list of Router resources available to the specified 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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (Router element : routersClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
Returns
Type Description
RoutersClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRoutersRequest,RouterList> listCallable()

Retrieves a list of Router resources available to the specified 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 (RoutersClient routersClient = RoutersClient.create()) {
   ListRoutersRequest request =
       ListRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     RouterList response = routersClient.listCallable().call(request);
     for (Router element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListRoutersRequest,RouterList>

listPagedCallable()

public final UnaryCallable<ListRoutersRequest,RoutersClient.ListPagedResponse> listPagedCallable()

Retrieves a list of Router resources available to the specified 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 (RoutersClient routersClient = RoutersClient.create()) {
   ListRoutersRequest request =
       ListRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Router> future = routersClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Router element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListRoutersRequest,ListPagedResponse>

patchAsync(PatchRouterRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchRouterRequest request)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (RoutersClient routersClient = RoutersClient.create()) {
   PatchRouterRequest request =
       PatchRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   Operation response = routersClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String router, Router routerResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String router, Router routerResource)

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   Router routerResource = Router.newBuilder().build();
   Operation response = routersClient.patchAsync(project, region, router, routerResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to patch.
routerResource Router

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchRouterRequest,Operation> patchCallable()

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (RoutersClient routersClient = RoutersClient.create()) {
   PatchRouterRequest request =
       PatchRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   ApiFuture<Operation> future = routersClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchRouterRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchRouterRequest,Operation,Operation> patchOperationCallable()

Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

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 (RoutersClient routersClient = RoutersClient.create()) {
   PatchRouterRequest request =
       PatchRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       routersClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchRouterRequest,Operation,Operation>

preview(PreviewRouterRequest request)

public final RoutersPreviewResponse preview(PreviewRouterRequest request)

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

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 (RoutersClient routersClient = RoutersClient.create()) {
   PreviewRouterRequest request =
       PreviewRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   RoutersPreviewResponse response = routersClient.preview(request);
 }
Parameter
Name Description
request PreviewRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RoutersPreviewResponse

preview(String project, String region, String router, Router routerResource)

public final RoutersPreviewResponse preview(String project, String region, String router, Router routerResource)

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   Router routerResource = Router.newBuilder().build();
   RoutersPreviewResponse response =
       routersClient.preview(project, region, router, routerResource);
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to query.
routerResource Router

The body resource for this request
Returns
Type Description
RoutersPreviewResponse

previewCallable()

public final UnaryCallable<PreviewRouterRequest,RoutersPreviewResponse> previewCallable()

Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.

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 (RoutersClient routersClient = RoutersClient.create()) {
   PreviewRouterRequest request =
       PreviewRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   ApiFuture<RoutersPreviewResponse> future =
       routersClient.previewCallable().futureCall(request);
   // Do something.
   RoutersPreviewResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<PreviewRouterRequest,RoutersPreviewResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAsync(UpdateRouterRequest request)

public final OperationFuture<Operation,Operation> updateAsync(UpdateRouterRequest request)

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

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 (RoutersClient routersClient = RoutersClient.create()) {
   UpdateRouterRequest request =
       UpdateRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   Operation response = routersClient.updateAsync(request).get();
 }
Parameter
Name Description
request UpdateRouterRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

updateAsync(String project, String region, String router, Router routerResource)

public final OperationFuture<Operation,Operation> updateAsync(String project, String region, String router, Router routerResource)

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

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 (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String router = "router-925132983";
   Router routerResource = Router.newBuilder().build();
   Operation response = routersClient.updateAsync(project, region, router, routerResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
region String

Name of the region for this request.
router String

Name of the Router resource to update.
routerResource Router

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

updateCallable()

public final UnaryCallable<UpdateRouterRequest,Operation> updateCallable()

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

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 (RoutersClient routersClient = RoutersClient.create()) {
   UpdateRouterRequest request =
       UpdateRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   ApiFuture<Operation> future = routersClient.updateCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateRouterRequest,Operation>

updateOperationCallable()

public final OperationCallable<UpdateRouterRequest,Operation,Operation> updateOperationCallable()

Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.

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 (RoutersClient routersClient = RoutersClient.create()) {
   UpdateRouterRequest request =
       UpdateRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       routersClient.updateOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateRouterRequest,Operation,Operation>