class TargetVpnGateways extends Resource (View source)

The "targetVpnGateways" collection of methods.

Typical usage is:

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

Methods

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

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

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

Deletes the specified target VPN gateway. (targetVpnGateways.delete)

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

Returns the specified target VPN gateway. (targetVpnGateways.get)

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

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

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

Retrieves a list of target VPN gateways available to the specified project and region. (targetVpnGateways.listTargetVpnGateways)

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

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

Details

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

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

Parameters

string $project

Project ID for this request.

array $optParams

Optional parameters.

Return Value

TargetVpnGatewayAggregatedList

Exceptions

Exception

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

Deletes the specified target VPN gateway. (targetVpnGateways.delete)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $targetVpnGateway

Name of the target VPN gateway to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Returns the specified target VPN gateway. (targetVpnGateways.get)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

string $targetVpnGateway

Name of the target VPN gateway to return.

array $optParams

Optional parameters.

Return Value

TargetVpnGateway

Exceptions

Exception

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

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

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

TargetVpnGateway $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Retrieves a list of target VPN gateways available to the specified project and region. (targetVpnGateways.listTargetVpnGateways)

Parameters

string $project

Project ID for this request.

string $region

Name of the region for this request.

array $optParams

Optional parameters.

Return Value

TargetVpnGatewayList

Exceptions

Exception

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

Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. (targetVpnGateways.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