Google Cloud Dialogflow Cx V3 Client - Class VersionsClient (0.3.4)

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
use Google\Cloud\Dialogflow\Cx\V3\CompareVersionsRequest;
use Google\Cloud\Dialogflow\Cx\V3\CompareVersionsResponse;

/**
 * @param string $formattedBaseVersion   Name of the base flow version to compare with the target version.
 *                                       Use version ID `0` to indicate the draft version of the specified flow.
 *
 *                                       Format: `projects/<Project ID>/locations/<Location ID>/agents/
 *                                       <Agent ID>/flows/<Flow ID>/versions/<Version ID>`. Please see
 *                                       {@see VersionsClient::versionName()} for help formatting this field.
 * @param string $formattedTargetVersion Name of the target flow version to compare with the
 *                                       base version. Use version ID `0` to indicate the draft version of the
 *                                       specified flow. Format: `projects/<Project ID>/locations/<Location
 *                                       ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`. Please see
 *                                       {@see VersionsClient::versionName()} for help formatting this field.
 */
function compare_versions_sample(
    string $formattedBaseVersion,
    string $formattedTargetVersion
): void {
    // Create a client.
    $versionsClient = new VersionsClient();

    // Prepare the request message.
    $request = (new CompareVersionsRequest())
        ->setBaseVersion($formattedBaseVersion)
        ->setTargetVersion($formattedTargetVersion);

    // Call the API and handle any network failures.
    try {
        /** @var CompareVersionsResponse $response */
        $response = $versionsClient->compareVersions($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
{
    $formattedBaseVersion = VersionsClient::versionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]',
        '[VERSION]'
    );
    $formattedTargetVersion = VersionsClient::versionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]',
        '[VERSION]'
    );

    compare_versions_sample($formattedBaseVersion, $formattedTargetVersion);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\Version;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an
 *                                   [Version][google.cloud.dialogflow.cx.v3.Version] for. Format:
 *                                   `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                                   ID>/flows/<Flow ID>`. Please see
 *                                   {@see VersionsClient::flowName()} for help formatting this field.
 * @param string $versionDisplayName The human-readable name of the version. Limit of 64 characters.
 */
function create_version_sample(string $formattedParent, string $versionDisplayName): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

    // Prepare the request message.
    $version = (new Version())
        ->setDisplayName($versionDisplayName);
    $request = (new CreateVersionRequest())
        ->setParent($formattedParent)
        ->setVersion($version);

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

        if ($response->operationSucceeded()) {
            /** @var Version $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 = VersionsClient::flowName('[PROJECT]', '[LOCATION]', '[AGENT]', '[FLOW]');
    $versionDisplayName = '[DISPLAY_NAME]';

    create_version_sample($formattedParent, $versionDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteVersionRequest;

/**
 * @param string $formattedName The name of the [Version][google.cloud.dialogflow.cx.v3.Version]
 *                              to delete. Format: `projects/<Project ID>/locations/<Location
 *                              ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`. Please see
 *                              {@see VersionsClient::versionName()} for help formatting this field.
 */
function delete_version_sample(string $formattedName): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

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

    // Call the API and handle any network failures.
    try {
        $versionsClient->deleteVersion($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 = VersionsClient::versionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]',
        '[VERSION]'
    );

    delete_version_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
use Google\Cloud\Dialogflow\Cx\V3\GetVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\Version;

/**
 * @param string $formattedName The name of the [Version][google.cloud.dialogflow.cx.v3.Version].
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/flows/<Flow ID>/versions/<Version ID>`. Please see
 *                              {@see VersionsClient::versionName()} for help formatting this field.
 */
function get_version_sample(string $formattedName): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Version $response */
        $response = $versionsClient->getVersion($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 = VersionsClient::versionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]',
        '[VERSION]'
    );

    get_version_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
use Google\Cloud\Dialogflow\Cx\V3\ListVersionsRequest;
use Google\Cloud\Dialogflow\Cx\V3\Version;

/**
 * @param string $formattedParent The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all
 *                                versions for. Format: `projects/<Project ID>/locations/<Location
 *                                ID>/agents/<Agent ID>/flows/<Flow ID>`. Please see
 *                                {@see VersionsClient::flowName()} for help formatting this field.
 */
function list_versions_sample(string $formattedParent): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

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

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

        /** @var Version $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 = VersionsClient::flowName('[PROJECT]', '[LOCATION]', '[AGENT]', '[FLOW]');

    list_versions_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
use Google\Cloud\Dialogflow\Cx\V3\LoadVersionRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded
 *                              to draft flow. Format: `projects/<Project ID>/locations/<Location
 *                              ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`. Please see
 *                              {@see VersionsClient::versionName()} for help formatting this field.
 */
function load_version_sample(string $formattedName): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $versionsClient->loadVersion($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 = VersionsClient::versionName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[FLOW]',
        '[VERSION]'
    );

    load_version_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
use Google\Cloud\Dialogflow\Cx\V3\UpdateVersionRequest;
use Google\Cloud\Dialogflow\Cx\V3\Version;
use Google\Protobuf\FieldMask;

/**
 * @param string $versionDisplayName The human-readable name of the version. Limit of 64 characters.
 */
function update_version_sample(string $versionDisplayName): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

    // Prepare the request message.
    $version = (new Version())
        ->setDisplayName($versionDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateVersionRequest())
        ->setVersion($version)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Version $response */
        $response = $versionsClient->updateVersion($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
{
    $versionDisplayName = '[DISPLAY_NAME]';

    update_version_sample($versionDisplayName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\VersionsClient;
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.
    $versionsClient = new VersionsClient();

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

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

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

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