Google Cloud Ai Platform V1 Client - Class SpecialistPoolServiceClient (1.11.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\SpecialistPoolServiceClient;
use Google\Cloud\AIPlatform\V1\CreateSpecialistPoolRequest;
use Google\Cloud\AIPlatform\V1\SpecialistPool;
use Google\Rpc\Status;

/**
 * @param string $formattedParent           The parent Project name for the new SpecialistPool.
 *                                          The form is `projects/{project}/locations/{location}`. Please see
 *                                          {@see SpecialistPoolServiceClient::locationName()} for help formatting this field.
 * @param string $specialistPoolName        The resource name of the SpecialistPool.
 * @param string $specialistPoolDisplayName The user-defined name of the SpecialistPool.
 *                                          The name can be up to 128 characters long and can consist of any UTF-8
 *                                          characters.
 *                                          This field should be unique on project-level.
 */
function create_specialist_pool_sample(
    string $formattedParent,
    string $specialistPoolName,
    string $specialistPoolDisplayName
): void {
    // Create a client.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

    // Prepare the request message.
    $specialistPool = (new SpecialistPool())
        ->setName($specialistPoolName)
        ->setDisplayName($specialistPoolDisplayName);
    $request = (new CreateSpecialistPoolRequest())
        ->setParent($formattedParent)
        ->setSpecialistPool($specialistPool);

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

        if ($response->operationSucceeded()) {
            /** @var SpecialistPool $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 = SpecialistPoolServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $specialistPoolName = '[NAME]';
    $specialistPoolDisplayName = '[DISPLAY_NAME]';

    create_specialist_pool_sample($formattedParent, $specialistPoolName, $specialistPoolDisplayName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\SpecialistPoolServiceClient;
use Google\Cloud\AIPlatform\V1\DeleteSpecialistPoolRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The resource name of the SpecialistPool to delete. Format:
 *                              `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`
 *                              Please see {@see SpecialistPoolServiceClient::specialistPoolName()} for help formatting this field.
 */
function delete_specialist_pool_sample(string $formattedName): void
{
    // Create a client.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $specialistPoolServiceClient->deleteSpecialistPool($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 = SpecialistPoolServiceClient::specialistPoolName(
        '[PROJECT]',
        '[LOCATION]',
        '[SPECIALIST_POOL]'
    );

    delete_specialist_pool_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\SpecialistPoolServiceClient;
use Google\Cloud\AIPlatform\V1\GetSpecialistPoolRequest;
use Google\Cloud\AIPlatform\V1\SpecialistPool;

/**
 * @param string $formattedName The name of the SpecialistPool resource.
 *                              The form is
 *                              `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`. Please see
 *                              {@see SpecialistPoolServiceClient::specialistPoolName()} for help formatting this field.
 */
function get_specialist_pool_sample(string $formattedName): void
{
    // Create a client.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var SpecialistPool $response */
        $response = $specialistPoolServiceClient->getSpecialistPool($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 = SpecialistPoolServiceClient::specialistPoolName(
        '[PROJECT]',
        '[LOCATION]',
        '[SPECIALIST_POOL]'
    );

    get_specialist_pool_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AIPlatform\V1\Client\SpecialistPoolServiceClient;
use Google\Cloud\AIPlatform\V1\ListSpecialistPoolsRequest;
use Google\Cloud\AIPlatform\V1\SpecialistPool;

/**
 * @param string $formattedParent The name of the SpecialistPool's parent resource.
 *                                Format: `projects/{project}/locations/{location}`
 *                                Please see {@see SpecialistPoolServiceClient::locationName()} for help formatting this field.
 */
function list_specialist_pools_sample(string $formattedParent): void
{
    // Create a client.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

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

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

        /** @var SpecialistPool $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 = SpecialistPoolServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_specialist_pools_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\AIPlatform\V1\Client\SpecialistPoolServiceClient;
use Google\Cloud\AIPlatform\V1\SpecialistPool;
use Google\Cloud\AIPlatform\V1\UpdateSpecialistPoolRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * @param string $specialistPoolName        The resource name of the SpecialistPool.
 * @param string $specialistPoolDisplayName The user-defined name of the SpecialistPool.
 *                                          The name can be up to 128 characters long and can consist of any UTF-8
 *                                          characters.
 *                                          This field should be unique on project-level.
 */
function update_specialist_pool_sample(
    string $specialistPoolName,
    string $specialistPoolDisplayName
): void {
    // Create a client.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

    // Prepare the request message.
    $specialistPool = (new SpecialistPool())
        ->setName($specialistPoolName)
        ->setDisplayName($specialistPoolDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateSpecialistPoolRequest())
        ->setSpecialistPool($specialistPool)
        ->setUpdateMask($updateMask);

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

        if ($response->operationSucceeded()) {
            /** @var SpecialistPool $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
{
    $specialistPoolName = '[NAME]';
    $specialistPoolDisplayName = '[DISPLAY_NAME]';

    update_specialist_pool_sample($specialistPoolName, $specialistPoolDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\AIPlatform\V1\Client\SpecialistPoolServiceClient;
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.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $specialistPoolServiceClient->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\SpecialistPoolServiceClient;
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.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $specialistPoolServiceClient->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\SpecialistPoolServiceClient;
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.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $specialistPoolServiceClient->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\SpecialistPoolServiceClient;
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.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

    // 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 = $specialistPoolServiceClient->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\SpecialistPoolServiceClient;
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.
    $specialistPoolServiceClient = new SpecialistPoolServiceClient();

    // 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 = $specialistPoolServiceClient->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);
}