Compute V1 Client - Class SubnetworksClient (1.23.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\AggregatedListSubnetworksRequest;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;

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

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

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

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region scoping this request.
 * @param string $subnetwork Name of the Subnetwork resource to delete.
 */
function delete_sample(string $project, string $region, string $subnetwork): void
{
    // Create a client.
    $subnetworksClient = new SubnetworksClient();

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

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

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

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\ExpandIpCidrRangeSubnetworkRequest;
use Google\Cloud\Compute\V1\SubnetworksExpandIpCidrRangeRequest;
use Google\Rpc\Status;

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region scoping this request.
 * @param string $subnetwork Name of the Subnetwork resource to update.
 */
function expand_ip_cidr_range_sample(string $project, string $region, string $subnetwork): void
{
    // Create a client.
    $subnetworksClient = new SubnetworksClient();

    // Prepare the request message.
    $subnetworksExpandIpCidrRangeRequestResource = new SubnetworksExpandIpCidrRangeRequest();
    $request = (new ExpandIpCidrRangeSubnetworkRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setSubnetwork($subnetwork)
        ->setSubnetworksExpandIpCidrRangeRequestResource($subnetworksExpandIpCidrRangeRequestResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subnetworksClient->expandIpCidrRange($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]';
    $subnetwork = '[SUBNETWORK]';

    expand_ip_cidr_range_sample($project, $region, $subnetwork);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\GetSubnetworkRequest;
use Google\Cloud\Compute\V1\Subnetwork;

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region scoping this request.
 * @param string $subnetwork Name of the Subnetwork resource to return.
 */
function get_sample(string $project, string $region, string $subnetwork): void
{
    // Create a client.
    $subnetworksClient = new SubnetworksClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Subnetwork $response */
        $response = $subnetworksClient->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]';
    $subnetwork = '[SUBNETWORK]';

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

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\GetIamPolicySubnetworkRequest;
use Google\Cloud\Compute\V1\Policy;

/**
 * @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 get_iam_policy_sample(string $project, string $region, string $resource): void
{
    // Create a client.
    $subnetworksClient = new SubnetworksClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $subnetworksClient->getIamPolicy($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]';

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

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\InsertSubnetworkRequest;
use Google\Cloud\Compute\V1\Subnetwork;
use Google\Rpc\Status;

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

    // Prepare the request message.
    $subnetworkResource = new Subnetwork();
    $request = (new InsertSubnetworkRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setSubnetworkResource($subnetworkResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subnetworksClient->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\SubnetworksClient;
use Google\Cloud\Compute\V1\ListSubnetworksRequest;

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

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

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

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

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

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

    list_usable_sample($project);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\PatchSubnetworkRequest;
use Google\Cloud\Compute\V1\Subnetwork;
use Google\Rpc\Status;

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region scoping this request.
 * @param string $subnetwork Name of the Subnetwork resource to patch.
 */
function patch_sample(string $project, string $region, string $subnetwork): void
{
    // Create a client.
    $subnetworksClient = new SubnetworksClient();

    // Prepare the request message.
    $subnetworkResource = new Subnetwork();
    $request = (new PatchSubnetworkRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setSubnetwork($subnetwork)
        ->setSubnetworkResource($subnetworkResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subnetworksClient->patch($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]';
    $subnetwork = '[SUBNETWORK]';

    patch_sample($project, $region, $subnetwork);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\Policy;
use Google\Cloud\Compute\V1\RegionSetPolicyRequest;
use Google\Cloud\Compute\V1\SetIamPolicySubnetworkRequest;

/**
 * @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 set_iam_policy_sample(string $project, string $region, string $resource): void
{
    // Create a client.
    $subnetworksClient = new SubnetworksClient();

    // Prepare the request message.
    $regionSetPolicyRequestResource = new RegionSetPolicyRequest();
    $request = (new SetIamPolicySubnetworkRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setRegionSetPolicyRequestResource($regionSetPolicyRequestResource)
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $subnetworksClient->setIamPolicy($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]';

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

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\SetPrivateIpGoogleAccessSubnetworkRequest;
use Google\Cloud\Compute\V1\SubnetworksSetPrivateIpGoogleAccessRequest;
use Google\Rpc\Status;

/**
 * @param string $project    Project ID for this request.
 * @param string $region     Name of the region scoping this request.
 * @param string $subnetwork Name of the Subnetwork resource.
 */
function set_private_ip_google_access_sample(
    string $project,
    string $region,
    string $subnetwork
): void {
    // Create a client.
    $subnetworksClient = new SubnetworksClient();

    // Prepare the request message.
    $subnetworksSetPrivateIpGoogleAccessRequestResource = new SubnetworksSetPrivateIpGoogleAccessRequest();
    $request = (new SetPrivateIpGoogleAccessSubnetworkRequest())
        ->setProject($project)
        ->setRegion($region)
        ->setSubnetwork($subnetwork)
        ->setSubnetworksSetPrivateIpGoogleAccessRequestResource(
            $subnetworksSetPrivateIpGoogleAccessRequestResource
        );

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $subnetworksClient->setPrivateIpGoogleAccess($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]';
    $subnetwork = '[SUBNETWORK]';

    set_private_ip_google_access_sample($project, $region, $subnetwork);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\SubnetworksClient;
use Google\Cloud\Compute\V1\TestIamPermissionsSubnetworkRequest;
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.
    $subnetworksClient = new SubnetworksClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var TestPermissionsResponse $response */
        $response = $subnetworksClient->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);
}