Google Cloud Model Armor V1 Client - Class ModelArmorClient (0.3.1)

use Google\ApiCore\ApiException;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\CreateTemplateRequest;
use Google\Cloud\ModelArmor\V1\FilterConfig;
use Google\Cloud\ModelArmor\V1\Template;

/**
 * @param string $formattedParent Value for parent. Please see
 *                                {@see ModelArmorClient::locationName()} for help formatting this field.
 * @param string $templateId      Id of the requesting object
 *                                If auto-generating Id server-side, remove this field and
 *                                template_id from the method_signature of Create RPC
 */
function create_template_sample(string $formattedParent, string $templateId): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

    // Prepare the request message.
    $templateFilterConfig = new FilterConfig();
    $template = (new Template())
        ->setFilterConfig($templateFilterConfig);
    $request = (new CreateTemplateRequest())
        ->setParent($formattedParent)
        ->setTemplateId($templateId)
        ->setTemplate($template);

    // Call the API and handle any network failures.
    try {
        /** @var Template $response */
        $response = $modelArmorClient->createTemplate($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 = ModelArmorClient::locationName('[PROJECT]', '[LOCATION]');
    $templateId = '[TEMPLATE_ID]';

    create_template_sample($formattedParent, $templateId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\DeleteTemplateRequest;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see ModelArmorClient::templateName()} for help formatting this field.
 */
function delete_template_sample(string $formattedName): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

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

    // Call the API and handle any network failures.
    try {
        $modelArmorClient->deleteTemplate($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 = ModelArmorClient::templateName('[PROJECT]', '[LOCATION]', '[TEMPLATE]');

    delete_template_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\FloorSetting;
use Google\Cloud\ModelArmor\V1\GetFloorSettingRequest;

/**
 * @param string $formattedName The name of the floor setting to get, example
 *                              projects/123/floorsetting. Please see
 *                              {@see ModelArmorClient::floorSettingName()} for help formatting this field.
 */
function get_floor_setting_sample(string $formattedName): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var FloorSetting $response */
        $response = $modelArmorClient->getFloorSetting($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 = ModelArmorClient::floorSettingName('[PROJECT]', '[LOCATION]');

    get_floor_setting_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\GetTemplateRequest;
use Google\Cloud\ModelArmor\V1\Template;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see ModelArmorClient::templateName()} for help formatting this field.
 */
function get_template_sample(string $formattedName): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Template $response */
        $response = $modelArmorClient->getTemplate($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 = ModelArmorClient::templateName('[PROJECT]', '[LOCATION]', '[TEMPLATE]');

    get_template_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\ListTemplatesRequest;
use Google\Cloud\ModelArmor\V1\Template;

/**
 * @param string $formattedParent Parent value for ListTemplatesRequest
 *                                Please see {@see ModelArmorClient::locationName()} for help formatting this field.
 */
function list_templates_sample(string $formattedParent): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

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

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

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

    list_templates_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\DataItem;
use Google\Cloud\ModelArmor\V1\SanitizeModelResponseRequest;
use Google\Cloud\ModelArmor\V1\SanitizeModelResponseResponse;

/**
 * @param string $formattedName Represents resource name of template
 *                              e.g. name=projects/sample-project/locations/us-central1/templates/templ01
 *                              Please see {@see ModelArmorClient::templateName()} for help formatting this field.
 */
function sanitize_model_response_sample(string $formattedName): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

    // Prepare the request message.
    $modelResponseData = new DataItem();
    $request = (new SanitizeModelResponseRequest())
        ->setName($formattedName)
        ->setModelResponseData($modelResponseData);

    // Call the API and handle any network failures.
    try {
        /** @var SanitizeModelResponseResponse $response */
        $response = $modelArmorClient->sanitizeModelResponse($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 = ModelArmorClient::templateName('[PROJECT]', '[LOCATION]', '[TEMPLATE]');

    sanitize_model_response_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\DataItem;
use Google\Cloud\ModelArmor\V1\SanitizeUserPromptRequest;
use Google\Cloud\ModelArmor\V1\SanitizeUserPromptResponse;

/**
 * @param string $formattedName Represents resource name of template
 *                              e.g. name=projects/sample-project/locations/us-central1/templates/templ01
 *                              Please see {@see ModelArmorClient::templateName()} for help formatting this field.
 */
function sanitize_user_prompt_sample(string $formattedName): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

    // Prepare the request message.
    $userPromptData = new DataItem();
    $request = (new SanitizeUserPromptRequest())
        ->setName($formattedName)
        ->setUserPromptData($userPromptData);

    // Call the API and handle any network failures.
    try {
        /** @var SanitizeUserPromptResponse $response */
        $response = $modelArmorClient->sanitizeUserPrompt($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 = ModelArmorClient::templateName('[PROJECT]', '[LOCATION]', '[TEMPLATE]');

    sanitize_user_prompt_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\FilterConfig;
use Google\Cloud\ModelArmor\V1\FloorSetting;
use Google\Cloud\ModelArmor\V1\UpdateFloorSettingRequest;

/**
 * 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_floor_setting_sample(): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

    // Prepare the request message.
    $floorSettingFilterConfig = new FilterConfig();
    $floorSetting = (new FloorSetting())
        ->setFilterConfig($floorSettingFilterConfig);
    $request = (new UpdateFloorSettingRequest())
        ->setFloorSetting($floorSetting);

    // Call the API and handle any network failures.
    try {
        /** @var FloorSetting $response */
        $response = $modelArmorClient->updateFloorSetting($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\Cloud\ModelArmor\V1\Client\ModelArmorClient;
use Google\Cloud\ModelArmor\V1\FilterConfig;
use Google\Cloud\ModelArmor\V1\Template;
use Google\Cloud\ModelArmor\V1\UpdateTemplateRequest;
use Google\Protobuf\FieldMask;

/**
 * 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_template_sample(): void
{
    // Create a client.
    $modelArmorClient = new ModelArmorClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $templateFilterConfig = new FilterConfig();
    $template = (new Template())
        ->setFilterConfig($templateFilterConfig);
    $request = (new UpdateTemplateRequest())
        ->setUpdateMask($updateMask)
        ->setTemplate($template);

    // Call the API and handle any network failures.
    try {
        /** @var Template $response */
        $response = $modelArmorClient->updateTemplate($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\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;

/**
 * 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.
    $modelArmorClient = new ModelArmorClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $modelArmorClient->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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\ModelArmor\V1\Client\ModelArmorClient;

/**
 * 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.
    $modelArmorClient = new ModelArmorClient();

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

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