Compute V1 Client - Class VpnGatewaysClient (1.23.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListVpnGatewaysRequest;
use Google\Cloud\Compute\V1\Client\VpnGatewaysClient;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vpnGatewaysClient->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\Client\VpnGatewaysClient;
use Google\Cloud\Compute\V1\DeleteVpnGatewayRequest;
use Google\Rpc\Status;

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region for this request.
 * @param string $vpnGateway Name of the VPN gateway to delete.
 */
function delete_sample(string $project, string $region, string $vpnGateway): void
{
    // Create a client.
    $vpnGatewaysClient = new VpnGatewaysClient();

    // Prepare the request message.
    $request = (new DeleteVpnGatewayRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setVpnGateway($vpnGateway);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vpnGatewaysClient->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
{
    $project = '[PROJECT]';
    $region = '[REGION]';
    $vpnGateway = '[VPN_GATEWAY]';

    delete_sample($project, $region, $vpnGateway);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\VpnGatewaysClient;
use Google\Cloud\Compute\V1\GetVpnGatewayRequest;
use Google\Cloud\Compute\V1\VpnGateway;

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region for this request.
 * @param string $vpnGateway Name of the VPN gateway to return.
 */
function get_sample(string $project, string $region, string $vpnGateway): void
{
    // Create a client.
    $vpnGatewaysClient = new VpnGatewaysClient();

    // Prepare the request message.
    $request = (new GetVpnGatewayRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setVpnGateway($vpnGateway);

    // Call the API and handle any network failures.
    try {
        /** @var VpnGateway $response */
        $response = $vpnGatewaysClient->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
{
    $project = '[PROJECT]';
    $region = '[REGION]';
    $vpnGateway = '[VPN_GATEWAY]';

    get_sample($project, $region, $vpnGateway);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\VpnGatewaysClient;
use Google\Cloud\Compute\V1\GetStatusVpnGatewayRequest;
use Google\Cloud\Compute\V1\VpnGatewaysGetStatusResponse;

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region for this request.
 * @param string $vpnGateway Name of the VPN gateway to return.
 */
function get_status_sample(string $project, string $region, string $vpnGateway): void
{
    // Create a client.
    $vpnGatewaysClient = new VpnGatewaysClient();

    // Prepare the request message.
    $request = (new GetStatusVpnGatewayRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setVpnGateway($vpnGateway);

    // Call the API and handle any network failures.
    try {
        /** @var VpnGatewaysGetStatusResponse $response */
        $response = $vpnGatewaysClient->getStatus($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]';
    $region = '[REGION]';
    $vpnGateway = '[VPN_GATEWAY]';

    get_status_sample($project, $region, $vpnGateway);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\VpnGatewaysClient;
use Google\Cloud\Compute\V1\InsertVpnGatewayRequest;
use Google\Cloud\Compute\V1\VpnGateway;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 * @param string $region  Name of the region for this request.
 */
function insert_sample(string $project, string $region): void
{
    // Create a client.
    $vpnGatewaysClient = new VpnGatewaysClient();

    // Prepare the request message.
    $vpnGatewayResource = new VpnGateway();
    $request = (new InsertVpnGatewayRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setVpnGatewayResource($vpnGatewayResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vpnGatewaysClient->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]';
    $region = '[REGION]';

    insert_sample($project, $region);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\VpnGatewaysClient;
use Google\Cloud\Compute\V1\ListVpnGatewaysRequest;

/**
 * @param string $project Project ID for this request.
 * @param string $region  Name of the region for this request.
 */
function list_sample(string $project, string $region): void
{
    // Create a client.
    $vpnGatewaysClient = new VpnGatewaysClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $vpnGatewaysClient->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]';
    $region = '[REGION]';

    list_sample($project, $region);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\VpnGatewaysClient;
use Google\Cloud\Compute\V1\RegionSetLabelsRequest;
use Google\Cloud\Compute\V1\SetLabelsVpnGatewayRequest;
use Google\Rpc\Status;

/**
 * @param string $project  Project ID for this request.
 * @param string $region   The region for this request.
 * @param string $resource Name or id of the resource for this request.
 */
function set_labels_sample(string $project, string $region, string $resource): void
{
    // Create a client.
    $vpnGatewaysClient = new VpnGatewaysClient();

    // Prepare the request message.
    $regionSetLabelsRequestResource = new RegionSetLabelsRequest();
    $request = (new SetLabelsVpnGatewayRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setRegionSetLabelsRequestResource($regionSetLabelsRequestResource)
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $vpnGatewaysClient->setLabels($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]';
    $region = '[REGION]';
    $resource = '[RESOURCE]';

    set_labels_sample($project, $region, $resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\VpnGatewaysClient;
use Google\Cloud\Compute\V1\TestIamPermissionsVpnGatewayRequest;
use Google\Cloud\Compute\V1\TestPermissionsRequest;
use Google\Cloud\Compute\V1\TestPermissionsResponse;

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

    // Prepare the request message.
    $testPermissionsRequestResource = new TestPermissionsRequest();
    $request = (new TestIamPermissionsVpnGatewayRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setResource($resource)
        ->setTestPermissionsRequestResource($testPermissionsRequestResource);

    // Call the API and handle any network failures.
    try {
        /** @var TestPermissionsResponse $response */
        $response = $vpnGatewaysClient->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]';
    $region = '[REGION]';
    $resource = '[RESOURCE]';

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