com.google.api.services.compute

Class Compute.Routers

java.lang.Object

com.google.api.services.compute.Compute.Routers

Enclosing class:

Compute

public class Compute.Routers
extends Object

The "routers" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Compute.Routers.AggregatedList
class	Compute.Routers.Delete
class	Compute.Routers.DeleteRoutePolicy
class	Compute.Routers.Get
class	Compute.Routers.GetNatIpInfo
class	Compute.Routers.GetNatMappingInfo
class	Compute.Routers.GetRoutePolicy
class	Compute.Routers.GetRouterStatus
class	Compute.Routers.Insert
class	Compute.Routers.List
class	Compute.Routers.ListBgpRoutes
class	Compute.Routers.ListRoutePolicies
class	Compute.Routers.Patch
class	Compute.Routers.PatchRoutePolicy
class	Compute.Routers.Preview
class	Compute.Routers.Update
class	Compute.Routers.UpdateRoutePolicy

Constructor Summary

Constructors

Constructor and Description
Routers()

Method Summary

Modifier and Type	Method and Description
Compute.Routers.AggregatedList	aggregatedList(String project) Retrieves an aggregated list of routers.
Compute.Routers.Delete	delete(String project, String region, String router) Deletes the specified Router resource.
Compute.Routers.DeleteRoutePolicy	deleteRoutePolicy(String project, String region, String router) Deletes Route Policy Create a request for the method "routers.deleteRoutePolicy".
Compute.Routers.Get	get(String project, String region, String router) Returns the specified Router resource.
Compute.Routers.GetNatIpInfo	getNatIpInfo(String project, String region, String router) Retrieves runtime NAT IP information.
Compute.Routers.GetNatMappingInfo	getNatMappingInfo(String project, String region, String router) Retrieves runtime Nat mapping information of VM endpoints.
Compute.Routers.GetRoutePolicy	getRoutePolicy(String project, String region, String router) Returns specified Route Policy Create a request for the method "routers.getRoutePolicy".
Compute.Routers.GetRouterStatus	getRouterStatus(String project, String region, String router) Retrieves runtime information of the specified router.
Compute.Routers.Insert	insert(String project, String region, Router content) Creates a Router resource in the specified project and region using the data included in the request.
Compute.Routers.List	list(String project, String region) Retrieves a list of Router resources available to the specified project.
Compute.Routers.ListBgpRoutes	listBgpRoutes(String project, String region, String router) Retrieves a list of router bgp routes available to the specified project.
Compute.Routers.ListRoutePolicies	listRoutePolicies(String project, String region, String router) Retrieves a list of router route policy subresources available to the specified project.
Compute.Routers.Patch	patch(String project, String region, String router, Router content) Patches the specified Router resource with the data included in the request.
Compute.Routers.PatchRoutePolicy	patchRoutePolicy(String project, String region, String router, RoutePolicy content) Patches Route Policy Create a request for the method "routers.patchRoutePolicy".
Compute.Routers.Preview	preview(String project, String region, String router, Router content) Preview fields auto-generated during router create andupdate operations.
Compute.Routers.Update	update(String project, String region, String router, Router content) Updates the specified Router resource with the data included in the request.
Compute.Routers.UpdateRoutePolicy	updateRoutePolicy(String project, String region, String router, RoutePolicy content) Updates or creates new Route Policy Create a request for the method "routers.updateRoutePolicy".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Routers

public Routers()

Method Detail

aggregatedList

public Compute.Routers.AggregatedList aggregatedList(String project)
                                              throws IOException

Retrieves an aggregated list of routers. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. Create a request for the method "routers.aggregatedList". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

Returns:

the request

Throws:

IOException

delete

public Compute.Routers.Delete delete(String project,
                                     String region,
                                     String router)
                              throws IOException

Deletes the specified Router resource. Create a request for the method "routers.delete". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to delete.

Returns:

the request

Throws:

IOException

deleteRoutePolicy

public Compute.Routers.DeleteRoutePolicy deleteRoutePolicy(String project,
                                                           String region,
                                                           String router)
                                                    throws IOException

Deletes Route Policy Create a request for the method "routers.deleteRoutePolicy". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource where Route Policy is defined.

Returns:

the request

Throws:

IOException

get

public Compute.Routers.Get get(String project,
                               String region,
                               String router)
                        throws IOException

Returns the specified Router resource. Create a request for the method "routers.get". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to return.

Returns:

the request

Throws:

IOException

getNatIpInfo

public Compute.Routers.GetNatIpInfo getNatIpInfo(String project,
                                                 String region,
                                                 String router)
                                          throws IOException

Retrieves runtime NAT IP information. Create a request for the method "routers.getNatIpInfo". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to query for Nat IP information. The name should conform to RFC1035.

Returns:

the request

Throws:

IOException

getNatMappingInfo

public Compute.Routers.GetNatMappingInfo getNatMappingInfo(String project,
                                                           String region,
                                                           String router)
                                                    throws IOException

Retrieves runtime Nat mapping information of VM endpoints. Create a request for the method "routers.getNatMappingInfo". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to query for Nat Mapping information of VM endpoints.

Returns:

the request

Throws:

IOException

getRoutePolicy

public Compute.Routers.GetRoutePolicy getRoutePolicy(String project,
                                                     String region,
                                                     String router)
                                              throws IOException

Returns specified Route Policy Create a request for the method "routers.getRoutePolicy". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to query for the route policy. The name should conform to RFC1035.

Returns:

the request

Throws:

IOException

getRouterStatus

public Compute.Routers.GetRouterStatus getRouterStatus(String project,
                                                       String region,
                                                       String router)
                                                throws IOException

Retrieves runtime information of the specified router. Create a request for the method "routers.getRouterStatus". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to query.

Returns:

the request

Throws:

IOException

insert

public Compute.Routers.Insert insert(String project,
                                     String region,
                                     Router content)
                              throws IOException

Creates a Router resource in the specified project and region using the data included in the request. Create a request for the method "routers.insert". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

content - the Router

Returns:

the request

Throws:

IOException

list

public Compute.Routers.List list(String project,
                                 String region)
                          throws IOException

Retrieves a list of Router resources available to the specified project. Create a request for the method "routers.list". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

Returns:

the request

Throws:

IOException

listBgpRoutes

public Compute.Routers.ListBgpRoutes listBgpRoutes(String project,
                                                   String region,
                                                   String router)
                                            throws IOException

Retrieves a list of router bgp routes available to the specified project. Create a request for the method "routers.listBgpRoutes". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name or id of the resource for this request. Name should conform to RFC1035.

Returns:

the request

Throws:

IOException

listRoutePolicies

public Compute.Routers.ListRoutePolicies listRoutePolicies(String project,
                                                           String region,
                                                           String router)
                                                    throws IOException

Retrieves a list of router route policy subresources available to the specified project. Create a request for the method "routers.listRoutePolicies". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name or id of the resource for this request. Name should conform to RFC1035.

Returns:

the request

Throws:

IOException

patch

public Compute.Routers.Patch patch(String project,
                                   String region,
                                   String router,
                                   Router content)
                            throws IOException

Patches the specified Router resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules. Create a request for the method "routers.patch". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to patch.

content - the Router

Returns:

the request

Throws:

IOException

patchRoutePolicy

public Compute.Routers.PatchRoutePolicy patchRoutePolicy(String project,
                                                         String region,
                                                         String router,
                                                         RoutePolicy content)
                                                  throws IOException

Patches Route Policy Create a request for the method "routers.patchRoutePolicy". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource where Route Policy is defined.

content - the RoutePolicy

Returns:

the request

Throws:

IOException

preview

public Compute.Routers.Preview preview(String project,
                                       String region,
                                       String router,
                                       Router content)
                                throws IOException

Preview fields auto-generated during router create andupdate operations. Calling this method does NOT create or update the router. Create a request for the method "routers.preview". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to query.

content - the Router

Returns:

the request

Throws:

IOException

update

public Compute.Routers.Update update(String project,
                                     String region,
                                     String router,
                                     Router content)
                              throws IOException

Updates the specified Router resource with the data included in the request. This method conforms toPUT 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. Create a request for the method "routers.update". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource to update.

content - the Router

Returns:

the request

Throws:

IOException

updateRoutePolicy

public Compute.Routers.UpdateRoutePolicy updateRoutePolicy(String project,
                                                           String region,
                                                           String router,
                                                           RoutePolicy content)
                                                    throws IOException

Updates or creates new Route Policy Create a request for the method "routers.updateRoutePolicy". This request holds the parameters needed by the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

project - Project ID for this request.

region - Name of the region for this request.

router - Name of the Router resource where Route Policy is defined.

content - the RoutePolicy

Returns:

the request

Throws:

IOException