Compute V1 Client - Class NetworkEndpointGroupsClient (1.22.0)

Reference documentation and code samples for the Compute V1 Client class NetworkEndpointGroupsClient.

Service Description: The NetworkEndpointGroups API.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Namespace

Google \ Cloud \ Compute \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. At the moment, supports only `rest`. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

aggregatedList

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.

The async variant is NetworkEndpointGroupsClient::aggregatedListAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AggregatedListNetworkEndpointGroupsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListNetworkEndpointGroupsRequest;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;

/**
 * @param string $project Project ID for this request.
 */
function aggregated_list_sample(string $project): void
{
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $request = (new AggregatedListNetworkEndpointGroupsRequest())
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $networkEndpointGroupsClient->aggregatedList($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';

    aggregated_list_sample($project);
}

attachNetworkEndpoints

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

The async variant is NetworkEndpointGroupsClient::attachNetworkEndpointsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AttachNetworkEndpointsNetworkEndpointGroupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\AttachNetworkEndpointsNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\NetworkEndpointGroupsAttachEndpointsRequest;
use Google\Rpc\Status;

/**
 * @param string $networkEndpointGroup The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
 * @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.
 */
function attach_network_endpoints_sample(
    string $networkEndpointGroup,
    string $project,
    string $zone
): void {
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $networkEndpointGroupsAttachEndpointsRequestResource = new NetworkEndpointGroupsAttachEndpointsRequest();
    $request = (new AttachNetworkEndpointsNetworkEndpointGroupRequest())
        ->setNetworkEndpointGroup($networkEndpointGroup)
        ->setNetworkEndpointGroupsAttachEndpointsRequestResource(
            $networkEndpointGroupsAttachEndpointsRequestResource
        )
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $networkEndpointGroupsClient->attachNetworkEndpoints($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    attach_network_endpoints_sample($networkEndpointGroup, $project, $zone);
}

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.

The async variant is NetworkEndpointGroupsClient::deleteAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteNetworkEndpointGroupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\DeleteNetworkEndpointGroupRequest;
use Google\Rpc\Status;

/**
 * @param string $networkEndpointGroup The name of the network endpoint group to delete. It should comply with RFC1035.
 * @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.
 */
function delete_sample(string $networkEndpointGroup, string $project, string $zone): void
{
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $request = (new DeleteNetworkEndpointGroupRequest())
        ->setNetworkEndpointGroup($networkEndpointGroup)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $networkEndpointGroupsClient->delete($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    delete_sample($networkEndpointGroup, $project, $zone);
}

detachNetworkEndpoints

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

The async variant is NetworkEndpointGroupsClient::detachNetworkEndpointsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DetachNetworkEndpointsNetworkEndpointGroupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\DetachNetworkEndpointsNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\NetworkEndpointGroupsDetachEndpointsRequest;
use Google\Rpc\Status;

/**
 * @param string $networkEndpointGroup The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
 * @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.
 */
function detach_network_endpoints_sample(
    string $networkEndpointGroup,
    string $project,
    string $zone
): void {
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $networkEndpointGroupsDetachEndpointsRequestResource = new NetworkEndpointGroupsDetachEndpointsRequest();
    $request = (new DetachNetworkEndpointsNetworkEndpointGroupRequest())
        ->setNetworkEndpointGroup($networkEndpointGroup)
        ->setNetworkEndpointGroupsDetachEndpointsRequestResource(
            $networkEndpointGroupsDetachEndpointsRequestResource
        )
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $networkEndpointGroupsClient->detachNetworkEndpoints($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    detach_network_endpoints_sample($networkEndpointGroup, $project, $zone);
}

get

Returns the specified network endpoint group.

The async variant is NetworkEndpointGroupsClient::getAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetNetworkEndpointGroupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\NetworkEndpointGroup`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\GetNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\NetworkEndpointGroup;

/**
 * @param string $networkEndpointGroup The name of the network endpoint group. It should comply with RFC1035.
 * @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.
 */
function get_sample(string $networkEndpointGroup, string $project, string $zone): void
{
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $request = (new GetNetworkEndpointGroupRequest())
        ->setNetworkEndpointGroup($networkEndpointGroup)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var NetworkEndpointGroup $response */
        $response = $networkEndpointGroupsClient->get($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    get_sample($networkEndpointGroup, $project, $zone);
}

insert

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

The async variant is NetworkEndpointGroupsClient::insertAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertNetworkEndpointGroupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\InsertNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\NetworkEndpointGroup;
use Google\Rpc\Status;

/**
 * @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.
 */
function insert_sample(string $project, string $zone): void
{
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $networkEndpointGroupResource = new NetworkEndpointGroup();
    $request = (new InsertNetworkEndpointGroupRequest())
        ->setNetworkEndpointGroupResource($networkEndpointGroupResource)
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $networkEndpointGroupsClient->insert($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    insert_sample($project, $zone);
}

list

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

The async variant is NetworkEndpointGroupsClient::listAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListNetworkEndpointGroupsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\ListNetworkEndpointGroupsRequest;

/**
 * @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.
 */
function list_sample(string $project, string $zone): void
{
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $request = (new ListNetworkEndpointGroupsRequest())
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $networkEndpointGroupsClient->list($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    list_sample($project, $zone);
}

listNetworkEndpoints

Lists the network endpoints in the specified network endpoint group.

The async variant is NetworkEndpointGroupsClient::listNetworkEndpointsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListNetworkEndpointsNetworkEndpointGroupsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\ListNetworkEndpointsNetworkEndpointGroupsRequest;
use Google\Cloud\Compute\V1\NetworkEndpointGroupsListEndpointsRequest;

/**
 * @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 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.
 */
function list_network_endpoints_sample(
    string $networkEndpointGroup,
    string $project,
    string $zone
): void {
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $networkEndpointGroupsListEndpointsRequestResource = new NetworkEndpointGroupsListEndpointsRequest();
    $request = (new ListNetworkEndpointsNetworkEndpointGroupsRequest())
        ->setNetworkEndpointGroup($networkEndpointGroup)
        ->setNetworkEndpointGroupsListEndpointsRequestResource(
            $networkEndpointGroupsListEndpointsRequestResource
        )
        ->setProject($project)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $networkEndpointGroupsClient->listNetworkEndpoints($request);

        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $networkEndpointGroup = '[NETWORK_ENDPOINT_GROUP]';
    $project = '[PROJECT]';
    $zone = '[ZONE]';

    list_network_endpoints_sample($networkEndpointGroup, $project, $zone);
}

testIamPermissions

Returns permissions that a caller has on the specified resource.

The async variant is NetworkEndpointGroupsClient::testIamPermissionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\TestIamPermissionsNetworkEndpointGroupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Compute\V1\TestPermissionsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\NetworkEndpointGroupsClient;
use Google\Cloud\Compute\V1\TestIamPermissionsNetworkEndpointGroupRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 * @param string $zone     The name of the zone for this request.
 */
function test_iam_permissions_sample(string $project, string $resource, string $zone): void
{
    // Create a client.
    $networkEndpointGroupsClient = new NetworkEndpointGroupsClient();

    // Prepare the request message.
    $testPermissionsRequestResource = new TestPermissionsRequest();
    $request = (new TestIamPermissionsNetworkEndpointGroupRequest())
        ->setProject($project)
        ->setResource($resource)
        ->setTestPermissionsRequestResource($testPermissionsRequestResource)
        ->setZone($zone);

    // Call the API and handle any network failures.
    try {
        /** @var TestPermissionsResponse $response */
        $response = $networkEndpointGroupsClient->testIamPermissions($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $project = '[PROJECT]';
    $resource = '[RESOURCE]';
    $zone = '[ZONE]';

    test_iam_permissions_sample($project, $resource, $zone);
}

aggregatedListAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AggregatedListNetworkEndpointGroupsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

attachNetworkEndpointsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\AttachNetworkEndpointsNetworkEndpointGroupRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

deleteAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteNetworkEndpointGroupRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

detachNetworkEndpointsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DetachNetworkEndpointsNetworkEndpointGroupRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetNetworkEndpointGroupRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\NetworkEndpointGroup>`

insertAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertNetworkEndpointGroupRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

listAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListNetworkEndpointGroupsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

listNetworkEndpointsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListNetworkEndpointsNetworkEndpointGroupsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

testIamPermissionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\TestIamPermissionsNetworkEndpointGroupRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TestPermissionsResponse>`

getOperationsClient

Return an ZoneOperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\Cloud\Compute\V1\ZoneOperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`