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.Get
class	Compute.Routers.GetNatIpInfo
class	Compute.Routers.GetNatMappingInfo
class	Compute.Routers.GetRouterStatus
class	Compute.Routers.Insert
class	Compute.Routers.List
class	Compute.Routers.Patch
class	Compute.Routers.Preview
class	Compute.Routers.Update

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.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.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.Patch	patch(String project, String region, String router, Router content) Patches the specified Router resource with the data included in the request.
Compute.Routers.Preview	preview(String project, String region, String router, Router content) Preview fields auto-generated during router create and update 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.

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

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

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

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 supports PATCH semantics and uses JSON 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

preview

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

Preview fields auto-generated during router create and update 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 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. 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