Google Cloud Ai Platform V1 Client - Class DeploymentResourcePoolServiceClient (0.30.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\AIPlatform\V1\CreateDeploymentResourcePoolRequest;
use Google\Cloud\AIPlatform\V1\DedicatedResources;
use Google\Cloud\AIPlatform\V1\DeploymentResourcePool;
use Google\Cloud\AIPlatform\V1\MachineSpec;
use Google\Rpc\Status;

/**
 * @param string $formattedParent                                         The parent location resource where this DeploymentResourcePool
 *                                                                        will be created. Format: `projects/{project}/locations/{location}`
 *                                                                        Please see {@see DeploymentResourcePoolServiceClient::locationName()} for help formatting this field.
 * @param int    $deploymentResourcePoolDedicatedResourcesMinReplicaCount Immutable. The minimum number of machine replicas this
 *                                                                        DeployedModel will be always deployed on. This value must be greater than
 *                                                                        or equal to 1.
 *
 *                                                                        If traffic against the DeployedModel increases, it may dynamically be
 *                                                                        deployed onto more replicas, and as traffic decreases, some of these extra
 *                                                                        replicas may be freed.
 * @param string $deploymentResourcePoolId                                The ID to use for the DeploymentResourcePool, which
 *                                                                        will become the final component of the DeploymentResourcePool's resource
 *                                                                        name.
 *
 *                                                                        The maximum length is 63 characters, and valid characters
 *                                                                        are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
 */
function create_deployment_resource_pool_sample(
    string $formattedParent,
    int $deploymentResourcePoolDedicatedResourcesMinReplicaCount,
    string $deploymentResourcePoolId
): void {
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $deploymentResourcePoolDedicatedResourcesMachineSpec = new MachineSpec();
    $deploymentResourcePoolDedicatedResources = (new DedicatedResources())
        ->setMachineSpec($deploymentResourcePoolDedicatedResourcesMachineSpec)
        ->setMinReplicaCount($deploymentResourcePoolDedicatedResourcesMinReplicaCount);
    $deploymentResourcePool = (new DeploymentResourcePool())
        ->setDedicatedResources($deploymentResourcePoolDedicatedResources);
    $request = (new CreateDeploymentResourcePoolRequest())
        ->setParent($formattedParent)
        ->setDeploymentResourcePool($deploymentResourcePool)
        ->setDeploymentResourcePoolId($deploymentResourcePoolId);

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

        if ($response->operationSucceeded()) {
            /** @var DeploymentResourcePool $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } 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
{
    $formattedParent = DeploymentResourcePoolServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $deploymentResourcePoolDedicatedResourcesMinReplicaCount = 0;
    $deploymentResourcePoolId = '[DEPLOYMENT_RESOURCE_POOL_ID]';

    create_deployment_resource_pool_sample(
        $formattedParent,
        $deploymentResourcePoolDedicatedResourcesMinReplicaCount,
        $deploymentResourcePoolId
    );
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteDeploymentResourcePoolRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the DeploymentResourcePool to delete.
 *                              Format:
 *                              `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
 *                              Please see {@see DeploymentResourcePoolServiceClient::deploymentResourcePoolName()} for help formatting this field.
 */
function delete_deployment_resource_pool_sample(string $formattedName): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $request = (new DeleteDeploymentResourcePoolRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $deploymentResourcePoolServiceClient->deleteDeploymentResourcePool($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
{
    $formattedName = DeploymentResourcePoolServiceClient::deploymentResourcePoolName(
        '[PROJECT]',
        '[LOCATION]',
        '[DEPLOYMENT_RESOURCE_POOL]'
    );

    delete_deployment_resource_pool_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\AIPlatform\V1\DeploymentResourcePool;
use Google\Cloud\AIPlatform\V1\GetDeploymentResourcePoolRequest;

/**
 * @param string $formattedName The name of the DeploymentResourcePool to retrieve.
 *                              Format:
 *                              `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
 *                              Please see {@see DeploymentResourcePoolServiceClient::deploymentResourcePoolName()} for help formatting this field.
 */
function get_deployment_resource_pool_sample(string $formattedName): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $request = (new GetDeploymentResourcePoolRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var DeploymentResourcePool $response */
        $response = $deploymentResourcePoolServiceClient->getDeploymentResourcePool($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
{
    $formattedName = DeploymentResourcePoolServiceClient::deploymentResourcePoolName(
        '[PROJECT]',
        '[LOCATION]',
        '[DEPLOYMENT_RESOURCE_POOL]'
    );

    get_deployment_resource_pool_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\AIPlatform\V1\DeploymentResourcePool;
use Google\Cloud\AIPlatform\V1\ListDeploymentResourcePoolsRequest;

/**
 * @param string $formattedParent The parent Location which owns this collection of
 *                                DeploymentResourcePools. Format: `projects/{project}/locations/{location}`
 *                                Please see {@see DeploymentResourcePoolServiceClient::projectName()} for help formatting this field.
 */
function list_deployment_resource_pools_sample(string $formattedParent): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $request = (new ListDeploymentResourcePoolsRequest())
        ->setParent($formattedParent);

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

        /** @var DeploymentResourcePool $element */
        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
{
    $formattedParent = DeploymentResourcePoolServiceClient::projectName('[PROJECT]');

    list_deployment_resource_pools_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\AIPlatform\V1\DeployedModel;
use Google\Cloud\AIPlatform\V1\QueryDeployedModelsRequest;

/**
 * @param string $deploymentResourcePool The name of the target DeploymentResourcePool to query.
 *                                       Format:
 *                                       `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`
 */
function query_deployed_models_sample(string $deploymentResourcePool): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $request = (new QueryDeployedModelsRequest())
        ->setDeploymentResourcePool($deploymentResourcePool);

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

        /** @var DeployedModel $element */
        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
{
    $deploymentResourcePool = '[DEPLOYMENT_RESOURCE_POOL]';

    query_deployed_models_sample($deploymentResourcePool);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $element */
        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());
    }
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

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

    get_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

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

    set_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\DeploymentResourcePoolServiceClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $deploymentResourcePoolServiceClient = new DeploymentResourcePoolServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

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

    test_iam_permissions_sample($resource, $permissionsElement);
}