Compute V1 Client - Class NetworkEndpointGroupsClient (1.29.0)

Stay organized with collections Save and categorize content based on your preferences.

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}

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);
}