Documentation

Google_Service_Compute_Resource_NetworkEndpointGroups extends Google_Service_Resource
in package

The "networkEndpointGroups" collection of methods.

Typical usage is: $computeService = new Google_Service_Compute(...); $networkEndpointGroups = $computeService->networkEndpointGroups;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
aggregatedList()  : Google_Service_Compute_NetworkEndpointGroupAggregatedList
Retrieves the list of network endpoint groups and sorts them by zone.
attachNetworkEndpoints()  : Google_Service_Compute_Operation
Attach a list of network endpoints to the specified network endpoint group.
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_Compute_Operation
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)
detachNetworkEndpoints()  : Google_Service_Compute_Operation
Detach a list of network endpoints from the specified network endpoint group.
get()  : Google_Service_Compute_NetworkEndpointGroup
Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.
insert()  : Google_Service_Compute_Operation
Creates a network endpoint group in the specified project using the parameters that are included in the request. (networkEndpointGroups.insert)
listNetworkEndpointGroups()  : Google_Service_Compute_NetworkEndpointGroupList
Retrieves the list of network endpoint groups that are located in the specified project and zone. (networkEndpointGroups.listNetworkEndpointGroups)
listNetworkEndpoints()  : Google_Service_Compute_NetworkEndpointGroupsListNetworkEndpoints
Lists the network endpoints in the specified network endpoint group.
testIamPermissions()  : Google_Service_Compute_TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

aggregatedList()

Retrieves the list of network endpoint groups and sorts them by zone.

public aggregatedList(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NetworkEndpointGroupAggregatedList

(networkEndpointGroups.aggregatedList)

Parameters
$project : string

Project ID for this request.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

bool includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_NetworkEndpointGroupAggregatedList —

attachNetworkEndpoints()

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

public attachNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, Google_Service_Compute_NetworkEndpointGroupsAttachEndpointsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

(networkEndpointGroups.attachNetworkEndpoints)

Parameters
$project : string

Project ID for this request.

$zone : string

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

$networkEndpointGroup : string

The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.

$postBody : Google_Service_Compute_NetworkEndpointGroupsAttachEndpointsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

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)

public delete(string $project, string $zone, string $networkEndpointGroup[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

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

$networkEndpointGroup : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

detachNetworkEndpoints()

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

public detachNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, Google_Service_Compute_NetworkEndpointGroupsDetachEndpointsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation

(networkEndpointGroups.detachNetworkEndpoints)

Parameters
$project : string

Project ID for this request.

$zone : string

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

$networkEndpointGroup : string

The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.

$postBody : Google_Service_Compute_NetworkEndpointGroupsDetachEndpointsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

get()

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

public get(string $project, string $zone, string $networkEndpointGroup[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NetworkEndpointGroup

(networkEndpointGroups.get)

Parameters
$project : string

Project ID for this request.

$zone : string

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

$networkEndpointGroup : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_NetworkEndpointGroup —

insert()

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

public insert(string $project, string $zone, Google_Service_Compute_NetworkEndpointGroup $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_Operation
Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.

$postBody : Google_Service_Compute_NetworkEndpointGroup
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Return values
Google_Service_Compute_Operation —

listNetworkEndpointGroups()

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

public listNetworkEndpointGroups(string $project, string $zone[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NetworkEndpointGroupList
Parameters
$project : string

Project ID for this request.

$zone : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_NetworkEndpointGroupList —

listNetworkEndpoints()

Lists the network endpoints in the specified network endpoint group.

public listNetworkEndpoints(string $project, string $zone, string $networkEndpointGroup, Google_Service_Compute_NetworkEndpointGroupsListEndpointsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_NetworkEndpointGroupsListNetworkEndpoints

(networkEndpointGroups.listNetworkEndpoints)

Parameters
$project : string

Project ID for this request.

$zone : string

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

$networkEndpointGroup : string

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

$postBody : Google_Service_Compute_NetworkEndpointGroupsListEndpointsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

opt_param

string maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

opt_param

string orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported.

opt_param

string pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

opt_param

bool returnPartialSuccess Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Return values
Google_Service_Compute_NetworkEndpointGroupsListNetworkEndpoints —

testIamPermissions()

Returns permissions that a caller has on the specified resource.

public testIamPermissions(string $project, string $zone, string $resource, Google_Service_Compute_TestPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Compute_TestPermissionsResponse

(networkEndpointGroups.testIamPermissions)

Parameters
$project : string

Project ID for this request.

$zone : string

The name of the zone for this request.

$resource : string

Name or id of the resource for this request.

$postBody : Google_Service_Compute_TestPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Compute_TestPermissionsResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results