1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. VpnGateways

VpnGateways

class VpnGateways extends Resource (View source)

The "vpnGateways" collection of methods.

Typical usage is:

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

Methods

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

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

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

Deletes the specified VPN gateway. (vpnGateways.delete)

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

Returns the specified VPN gateway. (vpnGateways.get)

VpnGatewaysGetStatusResponse
getStatus(string $project, string $region, string $vpnGateway, array $optParams = [])

Returns the status for the specified VPN gateway. (vpnGateways.getStatus)

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

Creates a VPN gateway in the specified project and region using the data included in the request. (vpnGateways.insert)

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

Retrieves a list of VPN gateways available to the specified project and region. (vpnGateways.listVpnGateways)

Operation
setLabels(string $project, string $region, string $resource, RegionSetLabelsRequest $postBody, array $optParams = [])

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (vpnGateways.setLabels)

TestPermissionsResponse
testIamPermissions(string $project, string $region, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

Details

at line 113
VpnGatewayAggregatedList aggregatedList(string $project, array $optParams = [])

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

(vpnGateways.aggregatedList)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

VpnGatewayAggregatedList

Exceptions

Exception

at line 140
Operation delete(string $project, string $region, string $vpnGateway, array $optParams = [])

Deletes the specified VPN gateway. (vpnGateways.delete)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $vpnGateway

Name of the VPN gateway to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 156
VpnGateway get(string $project, string $region, string $vpnGateway, array $optParams = [])

Returns the specified VPN gateway. (vpnGateways.get)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $vpnGateway

Name of the VPN gateway to return.
array $optParams

Optional parameters.

Return Value

VpnGateway

Exceptions

Exception

at line 172
VpnGatewaysGetStatusResponse getStatus(string $project, string $region, string $vpnGateway, array $optParams = [])

Returns the status for the specified VPN gateway. (vpnGateways.getStatus)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $vpnGateway

Name of the VPN gateway to return.
array $optParams

Optional parameters.

Return Value

VpnGatewaysGetStatusResponse

Exceptions

Exception

at line 200
Operation insert(string $project, string $region, VpnGateway $postBody, array $optParams = [])

Creates a VPN gateway in the specified project and region using the data included in the request. (vpnGateways.insert)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
VpnGateway $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 270
VpnGatewayList listVpnGateways(string $project, string $region, array $optParams = [])

Retrieves a list of VPN gateways available to the specified project and region. (vpnGateways.listVpnGateways)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
array $optParams

Optional parameters.

Return Value

VpnGatewayList

Exceptions

Exception

at line 299
Operation setLabels(string $project, string $region, string $resource, RegionSetLabelsRequest $postBody, array $optParams = [])

Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. (vpnGateways.setLabels)

Parameters

string $project

Project ID for this request.
string $region

The region for this request.
string $resource

Name or id of the resource for this request.
RegionSetLabelsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 317
TestPermissionsResponse testIamPermissions(string $project, string $region, string $resource, TestPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource.

(vpnGateways.testIamPermissions)

Parameters

string $project

Project ID for this request.
string $region

The name of the region for this request.
string $resource

Name or id of the resource for this request.
TestPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestPermissionsResponse

Exceptions

Exception