Google Cloud Dialogflow V2 Client - Class VersionsClient (1.4.0)

$versionsClient = new VersionsClient();
try {
    $formattedParent = $versionsClient->agentName('[PROJECT]');
    $version = new Version();
    $response = $versionsClient->createVersion($formattedParent, $version);
} finally {
    $versionsClient->close();
}

Methods

agentName

projectAgentName

projectLocationAgentName

projectLocationVersionName

projectVersionName

versionName

parseName

__construct

createVersion

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Version;
use Google\Cloud\Dialogflow\V2\VersionsClient;

/**
 * @param string $formattedParent The agent to create a version for.
 *                                Supported formats:
 *
 *                                - `projects/<Project ID>/agent`
 *                                - `projects/<Project ID>/locations/<Location ID>/agent`
 *                                Please see {@see VersionsClient::agentName()} for help formatting this field.
 */
function create_version_sample(string $formattedParent): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $version = new Version();

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

/**
 * 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::agentName('[PROJECT]');

    create_version_sample($formattedParent);
}

deleteVersion

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\VersionsClient;

/**
 * @param string $formattedName The name of the version to delete.
 *                              Supported formats:
 *
 *                              - `projects/<Project ID>/agent/versions/<Version ID>`
 *                              - `projects/<Project ID>/locations/<Location ID>/agent/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();

    // Call the API and handle any network failures.
    try {
        $versionsClient->deleteVersion($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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]', '[VERSION]');

    delete_version_sample($formattedName);
}

getVersion

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Version;
use Google\Cloud\Dialogflow\V2\VersionsClient;

/**
 * @param string $formattedName The name of the version.
 *                              Supported formats:
 *
 *                              - `projects/<Project ID>/agent/versions/<Version ID>`
 *                              - `projects/<Project ID>/locations/<Location ID>/agent/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();

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

/**
 * 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]', '[VERSION]');

    get_version_sample($formattedName);
}

listVersions

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Version;
use Google\Cloud\Dialogflow\V2\VersionsClient;

/**
 * @param string $formattedParent The agent to list all versions from.
 *                                Supported formats:
 *
 *                                - `projects/<Project ID>/agent`
 *                                - `projects/<Project ID>/locations/<Location ID>/agent`
 *                                Please see {@see VersionsClient::agentName()} for help formatting this field.
 */
function list_versions_sample(string $formattedParent): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

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

        /** @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());
    }
}

/**
 * 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::agentName('[PROJECT]');

    list_versions_sample($formattedParent);
}

updateVersion

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Version;
use Google\Cloud\Dialogflow\V2\VersionsClient;
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_version_sample(): void
{
    // Create a client.
    $versionsClient = new VersionsClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $version = new Version();
    $updateMask = new FieldMask();

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

getLocation

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\VersionsClient;
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();

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

listLocations

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\VersionsClient;
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();

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

        /** @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());
    }
}

Constants

SERVICE_NAME

Value: 'google.cloud.dialogflow.v2.Versions'

SERVICE_ADDRESS

Value: 'dialogflow.googleapis.com'

DEFAULT_SERVICE_PORT

Value: 443

CODEGEN_NAME

Value: 'gapic'