Google Cloud Dataplex V1 Client - Class BusinessGlossaryServiceClient (1.8.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\CreateGlossaryRequest;
use Google\Cloud\Dataplex\V1\Glossary;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource where this Glossary will be created.
 *                                Format: projects/{project_id_or_number}/locations/{location_id}
 *                                where `location_id` refers to a Google Cloud region. Please see
 *                                {@see BusinessGlossaryServiceClient::locationName()} for help formatting this field.
 * @param string $glossaryId      Glossary ID: Glossary identifier.
 */
function create_glossary_sample(string $formattedParent, string $glossaryId): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

    // Prepare the request message.
    $glossary = new Glossary();
    $request = (new CreateGlossaryRequest())
        ->setParent($formattedParent)
        ->setGlossaryId($glossaryId)
        ->setGlossary($glossary);

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

        if ($response->operationSucceeded()) {
            /** @var Glossary $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 = BusinessGlossaryServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $glossaryId = '[GLOSSARY_ID]';

    create_glossary_sample($formattedParent, $glossaryId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\CreateGlossaryCategoryRequest;
use Google\Cloud\Dataplex\V1\GlossaryCategory;

/**
 * @param string $formattedParent The parent resource where this GlossaryCategory will be created.
 *                                Format:
 *                                projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                                where `locationId` refers to a Google Cloud region. Please see
 *                                {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 * @param string $categoryId      GlossaryCategory identifier.
 * @param string $categoryParent  The immediate parent of the GlossaryCategory in the
 *                                resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 *                                Format:
 *                                projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                                OR
 *                                projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
 */
function create_glossary_category_sample(
    string $formattedParent,
    string $categoryId,
    string $categoryParent
): void {
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

    // Prepare the request message.
    $category = (new GlossaryCategory())
        ->setParent($categoryParent);
    $request = (new CreateGlossaryCategoryRequest())
        ->setParent($formattedParent)
        ->setCategoryId($categoryId)
        ->setCategory($category);

    // Call the API and handle any network failures.
    try {
        /** @var GlossaryCategory $response */
        $response = $businessGlossaryServiceClient->createGlossaryCategory($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
{
    $formattedParent = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );
    $categoryId = '[CATEGORY_ID]';
    $categoryParent = '[PARENT]';

    create_glossary_category_sample($formattedParent, $categoryId, $categoryParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\CreateGlossaryTermRequest;
use Google\Cloud\Dataplex\V1\GlossaryTerm;

/**
 * @param string $formattedParent     The parent resource where the GlossaryTerm will be created.
 *                                    Format:
 *                                    projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                                    where `location_id` refers to a Google Cloud region. Please see
 *                                    {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 * @param string $termId              GlossaryTerm identifier.
 * @param string $formattedTermParent The immediate parent of the GlossaryTerm in the
 *                                    resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 *                                    Format:
 *                                    projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                                    OR
 *                                    projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
 *                                    Please see {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 */
function create_glossary_term_sample(
    string $formattedParent,
    string $termId,
    string $formattedTermParent
): void {
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

    // Prepare the request message.
    $term = (new GlossaryTerm())
        ->setParent($formattedTermParent);
    $request = (new CreateGlossaryTermRequest())
        ->setParent($formattedParent)
        ->setTermId($termId)
        ->setTerm($term);

    // Call the API and handle any network failures.
    try {
        /** @var GlossaryTerm $response */
        $response = $businessGlossaryServiceClient->createGlossaryTerm($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
{
    $formattedParent = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );
    $termId = '[TERM_ID]';
    $formattedTermParent = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );

    create_glossary_term_sample($formattedParent, $termId, $formattedTermParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\DeleteGlossaryRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the Glossary to delete.
 *                              Format:
 *                              projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                              Please see {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 */
function delete_glossary_sample(string $formattedName): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $businessGlossaryServiceClient->deleteGlossary($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 = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );

    delete_glossary_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\DeleteGlossaryCategoryRequest;

/**
 * @param string $formattedName The name of the GlossaryCategory to delete.
 *                              Format:
 *                              projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
 *                              Please see {@see BusinessGlossaryServiceClient::glossaryCategoryName()} for help formatting this field.
 */
function delete_glossary_category_sample(string $formattedName): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $businessGlossaryServiceClient->deleteGlossaryCategory($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = BusinessGlossaryServiceClient::glossaryCategoryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]',
        '[GLOSSARY_CATEGORY]'
    );

    delete_glossary_category_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\DeleteGlossaryTermRequest;

/**
 * @param string $formattedName The name of the GlossaryTerm to delete.
 *                              Format:
 *                              projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
 *                              Please see {@see BusinessGlossaryServiceClient::glossaryTermName()} for help formatting this field.
 */
function delete_glossary_term_sample(string $formattedName): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $businessGlossaryServiceClient->deleteGlossaryTerm($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = BusinessGlossaryServiceClient::glossaryTermName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]',
        '[GLOSSARY_TERM]'
    );

    delete_glossary_term_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\GetGlossaryRequest;
use Google\Cloud\Dataplex\V1\Glossary;

/**
 * @param string $formattedName The name of the Glossary to retrieve.
 *                              Format:
 *                              projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                              Please see {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 */
function get_glossary_sample(string $formattedName): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Glossary $response */
        $response = $businessGlossaryServiceClient->getGlossary($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 = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );

    get_glossary_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\GetGlossaryCategoryRequest;
use Google\Cloud\Dataplex\V1\GlossaryCategory;

/**
 * @param string $formattedName The name of the GlossaryCategory to retrieve.
 *                              Format:
 *                              projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
 *                              Please see {@see BusinessGlossaryServiceClient::glossaryCategoryName()} for help formatting this field.
 */
function get_glossary_category_sample(string $formattedName): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var GlossaryCategory $response */
        $response = $businessGlossaryServiceClient->getGlossaryCategory($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 = BusinessGlossaryServiceClient::glossaryCategoryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]',
        '[GLOSSARY_CATEGORY]'
    );

    get_glossary_category_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\GetGlossaryTermRequest;
use Google\Cloud\Dataplex\V1\GlossaryTerm;

/**
 * @param string $formattedName The name of the GlossaryTerm to retrieve.
 *                              Format:
 *                              projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
 *                              Please see {@see BusinessGlossaryServiceClient::glossaryTermName()} for help formatting this field.
 */
function get_glossary_term_sample(string $formattedName): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var GlossaryTerm $response */
        $response = $businessGlossaryServiceClient->getGlossaryTerm($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 = BusinessGlossaryServiceClient::glossaryTermName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]',
        '[GLOSSARY_TERM]'
    );

    get_glossary_term_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\Glossary;
use Google\Cloud\Dataplex\V1\ListGlossariesRequest;

/**
 * @param string $formattedParent The parent, which has this collection of Glossaries.
 *                                Format: projects/{project_id_or_number}/locations/{location_id}
 *                                where `location_id` refers to a Google Cloud region. Please see
 *                                {@see BusinessGlossaryServiceClient::locationName()} for help formatting this field.
 */
function list_glossaries_sample(string $formattedParent): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

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

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

    list_glossaries_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\GlossaryCategory;
use Google\Cloud\Dataplex\V1\ListGlossaryCategoriesRequest;

/**
 * @param string $formattedParent The parent, which has this collection of GlossaryCategories.
 *                                Format:
 *                                projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                                Location is the Google Cloud region. Please see
 *                                {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 */
function list_glossary_categories_sample(string $formattedParent): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

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

        /** @var GlossaryCategory $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 = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );

    list_glossary_categories_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\GlossaryTerm;
use Google\Cloud\Dataplex\V1\ListGlossaryTermsRequest;

/**
 * @param string $formattedParent The parent, which has this collection of GlossaryTerms.
 *                                Format:
 *                                projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                                where `location_id` refers to a Google Cloud region. Please see
 *                                {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 */
function list_glossary_terms_sample(string $formattedParent): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

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

        /** @var GlossaryTerm $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 = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );

    list_glossary_terms_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\Glossary;
use Google\Cloud\Dataplex\V1\UpdateGlossaryRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * 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 update_glossary_sample(): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

    // Prepare the request message.
    $glossary = new Glossary();
    $updateMask = new FieldMask();
    $request = (new UpdateGlossaryRequest())
        ->setGlossary($glossary)
        ->setUpdateMask($updateMask);

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

        if ($response->operationSucceeded()) {
            /** @var Glossary $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());
    }
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\GlossaryCategory;
use Google\Cloud\Dataplex\V1\UpdateGlossaryCategoryRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $categoryParent The immediate parent of the GlossaryCategory in the
 *                               resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 *                               Format:
 *                               projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                               OR
 *                               projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
 */
function update_glossary_category_sample(string $categoryParent): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

    // Prepare the request message.
    $category = (new GlossaryCategory())
        ->setParent($categoryParent);
    $updateMask = new FieldMask();
    $request = (new UpdateGlossaryCategoryRequest())
        ->setCategory($category)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var GlossaryCategory $response */
        $response = $businessGlossaryServiceClient->updateGlossaryCategory($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
{
    $categoryParent = '[PARENT]';

    update_glossary_category_sample($categoryParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
use Google\Cloud\Dataplex\V1\GlossaryTerm;
use Google\Cloud\Dataplex\V1\UpdateGlossaryTermRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $formattedTermParent The immediate parent of the GlossaryTerm in the
 *                                    resource-hierarchy. It can either be a Glossary or a GlossaryCategory.
 *                                    Format:
 *                                    projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *                                    OR
 *                                    projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
 *                                    Please see {@see BusinessGlossaryServiceClient::glossaryName()} for help formatting this field.
 */
function update_glossary_term_sample(string $formattedTermParent): void
{
    // Create a client.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

    // Prepare the request message.
    $term = (new GlossaryTerm())
        ->setParent($formattedTermParent);
    $updateMask = new FieldMask();
    $request = (new UpdateGlossaryTermRequest())
        ->setTerm($term)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var GlossaryTerm $response */
        $response = $businessGlossaryServiceClient->updateGlossaryTerm($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
{
    $formattedTermParent = BusinessGlossaryServiceClient::glossaryName(
        '[PROJECT]',
        '[LOCATION]',
        '[GLOSSARY]'
    );

    update_glossary_term_sample($formattedTermParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
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.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

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

    // 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 = $businessGlossaryServiceClient->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\Dataplex\V1\Client\BusinessGlossaryServiceClient;
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.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

use Google\ApiCore\ApiException;
use Google\Cloud\Dataplex\V1\Client\BusinessGlossaryServiceClient;
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.
    $businessGlossaryServiceClient = new BusinessGlossaryServiceClient();

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

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

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

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