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

NetworkEndpointGroups

class NetworkEndpointGroups extends Resource (View source)

The "networkEndpointGroups" collection of methods.

Typical usage is:

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

Methods

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

Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. (networkEndpointGroups.aggregatedList)

Operation
attachNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest $postBody, array $optParams = [])

Attach a list of network endpoints to the specified network endpoint group.

Operation
delete(string $project, string $zone, string $networkEndpointGroup, array $optParams = [])

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (networkEndpointGroups.delete)

Operation
detachNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest $postBody, array $optParams = [])

Detach a list of network endpoints from the specified network endpoint group.

NetworkEndpointGroup
get(string $project, string $zone, string $networkEndpointGroup, array $optParams = [])

Returns the specified network endpoint group. (networkEndpointGroups.get)

Operation
insert(string $project, string $zone, NetworkEndpointGroup $postBody, array $optParams = [])

Creates a network endpoint group in the specified project using the parameters that are included in the request. (networkEndpointGroups.insert)

NetworkEndpointGroupList
listNetworkEndpointGroups(string $project, string $zone, array $optParams = [])

Retrieves the list of network endpoint groups that are located in the specified project and zone. (networkEndpointGroups.listNetworkEndpointGroups)

NetworkEndpointGroupsListNetworkEndpoints
listNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, NetworkEndpointGroupsListEndpointsRequest $postBody, array $optParams = [])

Lists the network endpoints in the specified network endpoint group.

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

Returns permissions that a caller has on the specified resource.

Details

at line 115
NetworkEndpointGroupAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves the list of network endpoint groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. (networkEndpointGroups.aggregatedList)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

NetworkEndpointGroupAggregatedList

Exceptions

Exception

at line 146
Operation attachNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest $postBody, array $optParams = [])

Attach a list of network endpoints to the specified network endpoint group.

(networkEndpointGroups.attachNetworkEndpoints)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.
string $networkEndpointGroup

The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
NetworkEndpointGroupsAttachEndpointsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 178
Operation delete(string $project, string $zone, string $networkEndpointGroup, array $optParams = [])

Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. (networkEndpointGroups.delete)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.
string $networkEndpointGroup

The name of the network endpoint group to delete. It should comply with RFC1035.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 209
Operation detachNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest $postBody, array $optParams = [])

Detach a list of network endpoints from the specified network endpoint group.

(networkEndpointGroups.detachNetworkEndpoints)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.
string $networkEndpointGroup

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
NetworkEndpointGroupsDetachEndpointsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 227
NetworkEndpointGroup get(string $project, string $zone, string $networkEndpointGroup, array $optParams = [])

Returns the specified network endpoint group. (networkEndpointGroups.get)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.
string $networkEndpointGroup

The name of the network endpoint group. It should comply with RFC1035.
array $optParams

Optional parameters.

Return Value

NetworkEndpointGroup

Exceptions

Exception

at line 256
Operation insert(string $project, string $zone, NetworkEndpointGroup $postBody, array $optParams = [])

Creates a network endpoint group in the specified project using the parameters that are included in the request. (networkEndpointGroups.insert)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.
NetworkEndpointGroup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 327
NetworkEndpointGroupList listNetworkEndpointGroups(string $project, string $zone, array $optParams = [])

Retrieves the list of network endpoint groups that are located in the specified project and zone. (networkEndpointGroups.listNetworkEndpointGroups)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.
array $optParams

Optional parameters.

Return Value

NetworkEndpointGroupList

Exceptions

Exception

at line 402
NetworkEndpointGroupsListNetworkEndpoints listNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, NetworkEndpointGroupsListEndpointsRequest $postBody, array $optParams = [])

Lists the network endpoints in the specified network endpoint group.

(networkEndpointGroups.listNetworkEndpoints)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone where the network endpoint group is located. It should comply with RFC1035.
string $networkEndpointGroup

The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
NetworkEndpointGroupsListEndpointsRequest $postBody
array $optParams

Optional parameters.

Return Value

NetworkEndpointGroupsListNetworkEndpoints

Exceptions

Exception

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

Returns permissions that a caller has on the specified resource.

(networkEndpointGroups.testIamPermissions)

Parameters

string $project

Project ID for this request.
string $zone

The name of the zone 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