📄 Source: NetworkEndpointGroups.php
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Compute\Resource;
use Google\Service\Compute\NetworkEndpointGroup;
use Google\Service\Compute\NetworkEndpointGroupAggregatedList;
use Google\Service\Compute\NetworkEndpointGroupList;
use Google\Service\Compute\NetworkEndpointGroupsAttachEndpointsRequest;
use Google\Service\Compute\NetworkEndpointGroupsDetachEndpointsRequest;
use Google\Service\Compute\NetworkEndpointGroupsListEndpointsRequest;
use Google\Service\Compute\NetworkEndpointGroupsListNetworkEndpoints;
use Google\Service\Compute\Operation;
use Google\Service\Compute\TestPermissionsRequest;
use Google\Service\Compute\TestPermissionsResponse;
/**
* The "networkEndpointGroups" collection of methods.
* Typical usage is:
* <code>
* $computeService = new Google\Service\Compute(...);
* $networkEndpointGroups = $computeService->networkEndpointGroups;
* </code>
*/
class NetworkEndpointGroups extends \Google\Service\Resource
{
/**
* 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)
*
* @param string $project Project ID for this request.
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. Most Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow API
* improvement proposal AIP-160. These two types of filter expressions cannot be
* mixed in one request.
*
* If you want to use AIP-160, your expression must specify the field name, an
* operator, and the value that you want to use for filtering. The value must be
* a string, a number, or a boolean. The 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`.
*
* The `:*` comparison can be used to test whether a key has been defined. For
* example, to find all objects with `owner` label use: ``` labels.owner:* ```
*
* 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 onresource 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) ```
*
* If you want to use a regular expression, use the `eq` (equal) or `ne` (not
* equal) operator against a single un-parenthesized expression with or without
* quotes or against multiple parenthesized expressions. Examples:
*
* `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'`
* `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2
* ne "literal")`
*
* The literal value is interpreted as a regular expression using GoogleRE2
* library syntax. The literal value must match the entire field.
*
* For example, to filter for instances that do not end with name "instance",
* you would use `name ne .*instance`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @opt_param string serviceProjectNumber The Shared VPC service project id or
* service project number for which aggregated list request is invoked for
* subnetworks list-usable api.
* @return NetworkEndpointGroupAggregatedList
* @throws \Google\Service\Exception
*/
public function aggregatedList($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('aggregatedList', [$params], NetworkEndpointGroupAggregatedList::class);
}
/**
* Attach a list of network endpoints to the specified network endpoint group.
* (networkEndpointGroups.attachNetworkEndpoints)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the network endpoint group is
* located. It should comply with RFC1035.
* @param string $networkEndpointGroup The name of the network endpoint group
* where you are attaching network endpoints to. It should comply with RFC1035.
* @param NetworkEndpointGroupsAttachEndpointsRequest $postBody
* @param array $optParams Optional parameters.
*
* @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 Operation
* @throws \Google\Service\Exception
*/
public function attachNetworkEndpoints($project, $zone, $networkEndpointGroup, NetworkEndpointGroupsAttachEndpointsRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone, 'networkEndpointGroup' => $networkEndpointGroup, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('attachNetworkEndpoints', [$params], Operation::class);
}
/**
* 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)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the network endpoint group is
* located. It should comply with RFC1035.
* @param string $networkEndpointGroup The name of the network endpoint group to
* delete. It should comply with RFC1035.
* @param array $optParams Optional parameters.
*
* @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 Operation
* @throws \Google\Service\Exception
*/
public function delete($project, $zone, $networkEndpointGroup, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone, 'networkEndpointGroup' => $networkEndpointGroup];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], Operation::class);
}
/**
* Detach a list of network endpoints from the specified network endpoint group.
* (networkEndpointGroups.detachNetworkEndpoints)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the network endpoint group is
* located. It should comply with RFC1035.
* @param string $networkEndpointGroup The name of the network endpoint group
* where you are removing network endpoints. It should comply with RFC1035.
* @param NetworkEndpointGroupsDetachEndpointsRequest $postBody
* @param array $optParams Optional parameters.
*
* @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 Operation
* @throws \Google\Service\Exception
*/
public function detachNetworkEndpoints($project, $zone, $networkEndpointGroup, NetworkEndpointGroupsDetachEndpointsRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone, 'networkEndpointGroup' => $networkEndpointGroup, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('detachNetworkEndpoints', [$params], Operation::class);
}
/**
* Returns the specified network endpoint group. (networkEndpointGroups.get)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the network endpoint group is
* located. It should comply with RFC1035.
* @param string $networkEndpointGroup The name of the network endpoint group.
* It should comply with RFC1035.
* @param array $optParams Optional parameters.
* @return NetworkEndpointGroup
* @throws \Google\Service\Exception
*/
public function get($project, $zone, $networkEndpointGroup, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone, 'networkEndpointGroup' => $networkEndpointGroup];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], NetworkEndpointGroup::class);
}
/**
* Creates a network endpoint group in the specified project using the
* parameters that are included in the request.
*
* Note: Use the following APIs to manage network endpoint groups: -
* To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity
* NEGs): zonal API - To manage NEGs with regional scope (such as
* regional internet NEGs, serverless NEGs, Private Service Connect NEGs):
* regional API - To manage NEGs with global scope (such as global
* internet NEGs):global API (networkEndpointGroups.insert)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where you want to create the network
* endpoint group. It should comply with RFC1035.
* @param NetworkEndpointGroup $postBody
* @param array $optParams Optional parameters.
*
* @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 Operation
* @throws \Google\Service\Exception
*/
public function insert($project, $zone, NetworkEndpointGroup $postBody, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], Operation::class);
}
/**
* Retrieves the list of network endpoint groups that are located in the
* specified project and zone. (networkEndpointGroups.listNetworkEndpointGroups)
*
* @param string $project Project ID for this request.
* @param string $zone The name of thezone where the network endpoint group is
* located. It should comply with RFC1035.
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. Most Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow API
* improvement proposal AIP-160. These two types of filter expressions cannot be
* mixed in one request.
*
* If you want to use AIP-160, your expression must specify the field name, an
* operator, and the value that you want to use for filtering. The value must be
* a string, a number, or a boolean. The 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`.
*
* The `:*` comparison can be used to test whether a key has been defined. For
* example, to find all objects with `owner` label use: ``` labels.owner:* ```
*
* 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 onresource 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) ```
*
* If you want to use a regular expression, use the `eq` (equal) or `ne` (not
* equal) operator against a single un-parenthesized expression with or without
* quotes or against multiple parenthesized expressions. Examples:
*
* `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'`
* `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2
* ne "literal")`
*
* The literal value is interpreted as a regular expression using GoogleRE2
* library syntax. The literal value must match the entire field.
*
* For example, to filter for instances that do not end with name "instance",
* you would use `name ne .*instance`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @return NetworkEndpointGroupList
* @throws \Google\Service\Exception
*/
public function listNetworkEndpointGroups($project, $zone, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], NetworkEndpointGroupList::class);
}
/**
* Lists the network endpoints in the specified network endpoint group.
* (networkEndpointGroups.listNetworkEndpoints)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone where the network endpoint group is
* located. It should comply with RFC1035.
* @param 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.
* @param NetworkEndpointGroupsListEndpointsRequest $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string filter A filter expression that filters resources listed in
* the response. Most Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow API
* improvement proposal AIP-160. These two types of filter expressions cannot be
* mixed in one request.
*
* If you want to use AIP-160, your expression must specify the field name, an
* operator, and the value that you want to use for filtering. The value must be
* a string, a number, or a boolean. The 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`.
*
* The `:*` comparison can be used to test whether a key has been defined. For
* example, to find all objects with `owner` label use: ``` labels.owner:* ```
*
* 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 onresource 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) ```
*
* If you want to use a regular expression, use the `eq` (equal) or `ne` (not
* equal) operator against a single un-parenthesized expression with or without
* quotes or against multiple parenthesized expressions. Examples:
*
* `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'`
* `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2
* ne "literal")`
*
* The literal value is interpreted as a regular expression using GoogleRE2
* library syntax. The literal value must match the entire field.
*
* For example, to filter for instances that do not end with name "instance",
* you would use `name ne .*instance`.
*
* You cannot combine constraints on multiple fields using regular expressions.
* @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.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @return NetworkEndpointGroupsListNetworkEndpoints
* @throws \Google\Service\Exception
*/
public function listNetworkEndpoints($project, $zone, $networkEndpointGroup, NetworkEndpointGroupsListEndpointsRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone, 'networkEndpointGroup' => $networkEndpointGroup, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('listNetworkEndpoints', [$params], NetworkEndpointGroupsListNetworkEndpoints::class);
}
/**
* Returns permissions that a caller has on the specified resource.
* (networkEndpointGroups.testIamPermissions)
*
* @param string $project Project ID for this request.
* @param string $zone The name of the zone for this request.
* @param string $resource Name or id of the resource for this request.
* @param TestPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($project, $zone, $resource, TestPermissionsRequest $postBody, $optParams = [])
{
$params = ['project' => $project, 'zone' => $zone, 'resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NetworkEndpointGroups::class, 'Google_Service_Compute_Resource_NetworkEndpointGroups');
← Back