Class RoutersClient (1.6.0-beta)

Version 1.6.0-beta

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.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.37.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.25.0
• 1.24.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.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class RoutersClient implements BackgroundResource

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:

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

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 RoutersSettings to create(). For example:

To customize credentials:

 RoutersSettings routersSettings =
     RoutersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RoutersClient routersClient = RoutersClient.create(routersSettings);
 

To customize the endpoint:

 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

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)

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.

Sample code:

 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)
           .build();
   for (Map.Entry

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.

Sample code:

 try (RoutersClient routersClient = RoutersClient.create()) {
   String project = "project-309310695";
   for (Map.Entry

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.

Sample code:

 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)
           .build();
   while (true) {
     RouterAggregatedList response = routersClient.aggregatedListCallable().call(request);
     for (Map.Entry

Returns

Type	Description
UnaryCallable<AggregatedListRoutersRequest,RouterAggregatedList>

aggregatedListPagedCallable()

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

Retrieves an aggregated list of routers.

Sample code:

 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)
           .build();
   ApiFuture<>

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

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

deleteAsync(DeleteRouterRequest request)

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

Deletes the specified Router resource.

Sample code:

 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:

 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:

 try (RoutersClient routersClient = RoutersClient.create()) {
   DeleteRouterRequest request =
       DeleteRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<DeleteRouterRequest,Operation>

deleteOperationCallable()

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

Deletes the specified Router resource.

Sample code:

 try (RoutersClient routersClient = RoutersClient.create()) {
   DeleteRouterRequest request =
       DeleteRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouter("router-925132983")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteRouterRequest,Operation,Operation>

get(GetRouterRequest request)

public final Router get(GetRouterRequest request)

Returns the specified Router resource. Gets a list of available routers by making a list() request.

Sample code:

 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. Gets a list of available routers by making a list() request.

Sample code:

 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. Gets a list of available routers by making a list() request.

Sample code:

 try (RoutersClient routersClient = RoutersClient.create()) {
   GetRouterRequest request =
       GetRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetRouterRequest,Router>

getNatMappingInfo(GetNatMappingInfoRoutersRequest request)

public final RoutersClient.GetNatMappingInfoPagedResponse getNatMappingInfo(GetNatMappingInfoRoutersRequest request)

Retrieves runtime Nat mapping information of VM endpoints.

Sample code:

 try (RoutersClient routersClient = RoutersClient.create()) {
   GetNatMappingInfoRoutersRequest request =
       GetNatMappingInfoRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .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:

 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:

 try (RoutersClient routersClient = RoutersClient.create()) {
   GetNatMappingInfoRoutersRequest request =
       GetNatMappingInfoRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .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.getResponsesList()) {
       // 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:

 try (RoutersClient routersClient = RoutersClient.create()) {
   GetNatMappingInfoRoutersRequest request =
       GetNatMappingInfoRoutersRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .setRouter("router-925132983")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetNatMappingInfoRoutersRequest,GetNatMappingInfoPagedResponse>

getRouterStatus(GetRouterStatusRouterRequest request)

public final RouterStatusResponse getRouterStatus(GetRouterStatusRouterRequest request)

Retrieves runtime information of the specified router.

Sample code:

 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:

 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:

 try (RoutersClient routersClient = RoutersClient.create()) {
   GetRouterStatusRouterRequest request =
       GetRouterStatusRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .build();
   ApiFuture

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:

 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:

 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:

 try (RoutersClient routersClient = RoutersClient.create()) {
   InsertRouterRequest request =
       InsertRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouterResource(Router.newBuilder().build())
           .build();
   ApiFuture

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:

 try (RoutersClient routersClient = RoutersClient.create()) {
   InsertRouterRequest request =
       InsertRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setRouterResource(Router.newBuilder().build())
           .build();
   OperationFuture

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:

 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:

 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:

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

 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

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:

 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:

 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:

 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

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:

 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

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:

 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:

 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:

 try (RoutersClient routersClient = RoutersClient.create()) {
   PreviewRouterRequest request =
       PreviewRouterRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRouter("router-925132983")
           .setRouterResource(Router.newBuilder().build())
           .build();
   ApiFuture

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:

 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:

 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:

 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

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:

 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

Returns

Type	Description
OperationCallable<UpdateRouterRequest,Operation,Operation>