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

TargetVpnGateways

class TargetVpnGateways extends Resource (View source)

The "targetVpnGateways" collection of methods.

Typical usage is:

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

Methods

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)

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

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

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

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

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)

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

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

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)

Details

at line 110
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

at line 137
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

at line 153
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

at line 181
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

at line 251
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

at line 280
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