Routers
class Routers extends Resource (View source)
The "routers" collection of methods.
Typical usage is:
$computeService = new Google\Service\Compute(...);
$routers = $computeService->routers;
Methods
Retrieves an aggregated list of routers. To prevent failure, Google
recommends that you set the returnPartialSuccess
parameter to true
.
Deletes the specified Router resource. (routers.delete)
Returns the specified Router resource. (routers.get)
Retrieves runtime NAT IP information. (routers.getNatIpInfo)
Retrieves runtime Nat mapping information of VM endpoints.
Retrieves runtime information of the specified router.
Retrieves a list of Router resources available to the specified project.
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)
Operation
delete(string $project, string $region, string $router, array $optParams = [])
Deletes the specified Router resource. (routers.delete)
Router
get(string $project, string $region, string $router, array $optParams = [])
Returns the specified Router resource. (routers.get)
NatIpInfoResponse
getNatIpInfo(string $project, string $region, string $router, array $optParams = [])
Retrieves runtime NAT IP information. (routers.getNatIpInfo)
VmEndpointNatMappingsList
getNatMappingInfo(string $project, string $region, string $router, array $optParams = [])
Retrieves runtime Nat mapping information of VM endpoints.
(routers.getNatMappingInfo)
RouterStatusResponse
getRouterStatus(string $project, string $region, string $router, array $optParams = [])
Retrieves runtime information of the specified router.
(routers.getRouterStatus)
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)
RouterList
listRouters(string $project, string $region, array $optParams = [])
Retrieves a list of Router resources available to the specified project.
(routers.listRouters)
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)
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)
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)