class Routers extends Resource (View source)

The "routers" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $routers = $computeService->routers;

Methods

aggregatedList(string $project, array $optParams = [])

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

delete(string $project, string $region, string $router, array $optParams = [])

Deletes the specified Router resource. (routers.delete)

get(string $project, string $region, string $router, array $optParams = [])

Returns the specified Router resource. (routers.get)

getNatIpInfo(string $project, string $region, string $router, array $optParams = [])

Retrieves runtime NAT IP information. (routers.getNatIpInfo)

getNatMappingInfo(string $project, string $region, string $router, array $optParams = [])

Retrieves runtime Nat mapping information of VM endpoints.

getRouterStatus(string $project, string $region, string $router, array $optParams = [])

Retrieves runtime information of the specified router.

insert(string $project, string $region, Router $postBody, array $optParams = [])

Creates a Router resource in the specified project and region using the data included in the request. (routers.insert)

listRouters(string $project, string $region, array $optParams = [])

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

patch(string $project, string $region, string $router, Router $postBody, array $optParams = [])

Patches the specified Router resource with the data included in the request.

preview(string $project, string $region, string $router, Router $postBody, array $optParams = [])

Preview fields auto-generated during router create and update operations.

update(string $project, string $region, string $router, Router $postBody, array $optParams = [])

Updates the specified Router resource with the data included in the request.

Details

RouterAggregatedList aggregatedList(string $project, array $optParams = [])

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

(routers.aggregatedList)

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

RouterAggregatedList

Exceptions

Exception

Operation delete(string $project, string $region, string $router, array $optParams = [])

Deletes the specified Router resource. (routers.delete)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

Name of the Router resource to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Router get(string $project, string $region, string $router, array $optParams = [])

Returns the specified Router resource. (routers.get)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

Name of the Router resource to return.

array $optParams

Optional parameters.

Return Value

Router

Exceptions

Exception

NatIpInfoResponse getNatIpInfo(string $project, string $region, string $router, array $optParams = [])

Retrieves runtime NAT IP information. (routers.getNatIpInfo)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

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

array $optParams

Optional parameters.

Return Value

NatIpInfoResponse

Exceptions

Exception

VmEndpointNatMappingsList getNatMappingInfo(string $project, string $region, string $router, array $optParams = [])

Retrieves runtime Nat mapping information of VM endpoints.

(routers.getNatMappingInfo)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

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

array $optParams

Optional parameters.

Return Value

VmEndpointNatMappingsList

Exceptions

Exception

RouterStatusResponse getRouterStatus(string $project, string $region, string $router, array $optParams = [])

Retrieves runtime information of the specified router.

(routers.getRouterStatus)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

Name of the Router resource to query.

array $optParams

Optional parameters.

Return Value

RouterStatusResponse

Exceptions

Exception

Operation insert(string $project, string $region, Router $postBody, array $optParams = [])

Creates a Router resource in the specified project and region using the data included in the request. (routers.insert)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

Router $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

RouterList listRouters(string $project, string $region, array $optParams = [])

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

(routers.listRouters)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

array $optParams

Optional parameters.

Return Value

RouterList

Exceptions

Exception

Operation patch(string $project, string $region, string $router, Router $postBody, array $optParams = [])

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

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

Name of the Router resource to patch.

Router $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

RoutersPreviewResponse preview(string $project, string $region, string $router, Router $postBody, array $optParams = [])

Preview fields auto-generated during router create and update operations.

Calling this method does NOT create or update the router. (routers.preview)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

Name of the Router resource to query.

Router $postBody
array $optParams

Optional parameters.

Return Value

RoutersPreviewResponse

Exceptions

Exception

Operation update(string $project, string $region, string $router, Router $postBody, array $optParams = [])

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

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $router

Name of the Router resource to update.

Router $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception