Google Cloud Dialogflow V2 Client - Class VersionsClient (1.9.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class VersionsClient.

Service Description: Service for managing Versions .

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

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

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This service has a new (beta) implementation. See Google\Cloud\Dialogflow\V2\Client\VersionsClient to use the new surface.

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
options
array

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint
string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials
string|array|FetchAuthTokenInterface|CredentialsWrapper

The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage : In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.

↳ credentialsConfig
array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries
bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false .

↳ clientConfig
string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport
string|TransportInterface

The transport used for executing network requests. May be either the string rest or grpc . Defaults to grpc if gRPC support is detected on the system. Advanced usage : Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfig
array

Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.

↳ clientCertSource
callable

A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createVersion

Creates an agent version.

The new version points to the agent instance in the "default" environment.

Parameters
Name
Description
parent
string

Required. The agent to create a version for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
version
Google\Cloud\Dialogflow\V2\Version

Required. The version to create.

optionalArgs
array

Optional.

↳ retrySettings
RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type
Description
Google\Cloud\Dialogflow\V2\Version
Example 
 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());
    }
}

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

    create_version_sample($formattedParent);
}

deleteVersion

Delete the specified agent version.

Parameters
Name
Description
name
string

Required. 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>
optionalArgs
array

Optional.

↳ retrySettings
RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example 
 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());
    }
}

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

    delete_version_sample($formattedName);
}

getVersion

Retrieves the specified agent version.

Parameters
Name
Description
name
string

Required. The name of the version. Supported formats:

  • projects/<Project ID>/agent/versions/<Version ID>
  • projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
optionalArgs
array

Optional.

↳ retrySettings
RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type
Description
Google\Cloud\Dialogflow\V2\Version
Example 
 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());
    }
}

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

    get_version_sample($formattedName);
}

listVersions

Returns the list of all versions of the specified agent.

Parameters
Name
Description
parent
string

Required. The agent to list all versions from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
optionalArgs
array

Optional.

↳ pageSize
int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken
string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ retrySettings
RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type
Description
Google\ApiCore\PagedListResponse
Example 
 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());
    }
}

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

    list_versions_sample($formattedParent);
}

updateVersion

Updates the specified agent version.

Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

Parameters
Name
Description
version
Google\Cloud\Dialogflow\V2\Version

Required. The version to update. Supported formats:

  • projects/<Project ID>/agent/versions/<Version ID>
  • projects/<Project ID>/locations/<Location ID>/agent/versions/<Version ID>
updateMask
Google\Protobuf\FieldMask

Required. The mask to control which fields get updated.

optionalArgs
array

Optional.

↳ retrySettings
RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type
Description
Google\Cloud\Dialogflow\V2\Version
Example 
 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

Gets information about a location.

Parameters
Name
Description
optionalArgs
array

Optional.

↳ name
string

Resource name for the location.

↳ retrySettings
RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type
Description
Google\Cloud\Location\Location
Example 
 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

Lists information about the supported locations for this service.

Parameters
Name
Description
optionalArgs
array

Optional.

↳ name
string

The resource that owns the locations collection, if applicable.

↳ filter
string

The standard list filter.

↳ pageSize
int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken
string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ retrySettings
RetrySettings|array

Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type
Description
Google\ApiCore\PagedListResponse
Example 
 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());
    }
}

static::agentName

Formats a string containing the fully-qualified path to represent a agent resource.

Parameter
Name
Description
project
string
Returns
Type
Description
string
The formatted agent resource.

static::projectAgentName

Formats a string containing the fully-qualified path to represent a project_agent resource.

Parameter
Name
Description
project
string
Returns
Type
Description
string
The formatted project_agent resource.

static::projectLocationAgentName

Formats a string containing the fully-qualified path to represent a project_location_agent resource.

Parameters
Name
Description
project
string
location
string
Returns
Type
Description
string
The formatted project_location_agent resource.

static::projectLocationVersionName

Formats a string containing the fully-qualified path to represent a project_location_version resource.

Parameters
Name
Description
project
string
location
string
version
string
Returns
Type
Description
string
The formatted project_location_version resource.

static::projectVersionName

Formats a string containing the fully-qualified path to represent a project_version resource.

Parameters
Name
Description
project
string
version
string
Returns
Type
Description
string
The formatted project_version resource.

static::versionName

Formats a string containing the fully-qualified path to represent a version resource.

Parameters
Name
Description
project
string
version
string
Returns
Type
Description
string
The formatted version resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

  • agent: projects/{project}/agent
  • projectAgent: projects/{project}/agent
  • projectLocationAgent: projects/{project}/locations/{location}/agent
  • projectLocationVersion: projects/{project}/locations/{location}/agent/versions/{version}
  • projectVersion: projects/{project}/agent/versions/{version}
  • version: projects/{project}/agent/versions/{version}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name
Description
formattedName
string

The formatted name string

template
string

Optional name of template to match

Returns
Type
Description
array
An associative array from name component IDs to component values.

Constants

SERVICE_NAME

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

The name of the service.

SERVICE_ADDRESS

 Value: 'dialogflow.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

 Value: 443

The default port of the service.

CODEGEN_NAME

 Value: 'gapic'

The name of the code generator, to be included in the agent header.