Google Cloud Dialogflow Cx V3 Client - Class ChangelogsClient (0.1.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class ChangelogsClient.

Service Description: Service for managing Changelogs .

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:

 $changelogsClient = new ChangelogsClient();
try {
    $formattedName = $changelogsClient->changelogName('[PROJECT]', '[LOCATION]', '[AGENT]', '[CHANGELOG]');
    $response = $changelogsClient->getChangelog($formattedName);
} finally {
    $changelogsClient->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.

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

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.

getChangelog

Retrieves the specified Changelog.

Parameters
Name
Description
name
string

Required. The name of the changelog to get. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/changelogs/<Changelog 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
Example
 use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Changelog;
use Google\Cloud\Dialogflow\Cx\V3\ChangelogsClient;

/**
 * @param string $formattedName The name of the changelog to get.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/changelogs/<Changelog ID>`. Please see
 *                              {@see ChangelogsClient::changelogName()} for help formatting this field.
 */
function get_changelog_sample(string $formattedName): void
{
    // Create a client.
    $changelogsClient = new ChangelogsClient();

    // Call the API and handle any network failures.
    try {
        /** @var Changelog $response */
        $response = $changelogsClient->getChangelog($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 = ChangelogsClient::changelogName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[CHANGELOG]'
    );

    get_changelog_sample($formattedName);
} 

listChangelogs

Returns the list of Changelogs.

Parameters
Name
Description
parent
string

Required. The agent containing the changelogs. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID> .

optionalArgs
array

Optional.

↳ filter
string

The filter string. Supports filter by user_email, resource, type and create_time. Some examples: 1. By user email: user_email = "someone@google.com" 2. By resource name: resource = "projects/123/locations/global/agents/456/flows/789" 3. By resource display name: display_name = "my agent" 4. By action: action = "Create" 5. By type: type = "flows" 6. By create time. Currently predicates on create_time and create_time_epoch_seconds are supported: create_time_epoch_seconds > 1551790877 AND create_time <= 2017-01-15T01:30:15.01Z 7. Combination of above filters: resource = "projects/123/locations/global/agents/456/flows/789" AND user_email = "someone@google.com" AND create_time <= 2017-01-15T01:30:15.01Z

↳ 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
Example
 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Changelog;
use Google\Cloud\Dialogflow\Cx\V3\ChangelogsClient;

/**
 * @param string $formattedParent The agent containing the changelogs.
 *                                Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                {@see ChangelogsClient::agentName()} for help formatting this field.
 */
function list_changelogs_sample(string $formattedParent): void
{
    // Create a client.
    $changelogsClient = new ChangelogsClient();

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

        /** @var Changelog $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 = ChangelogsClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');

    list_changelogs_sample($formattedParent);
} 

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $changelogsClient->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
Example
 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\ChangelogsClient;
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.
    $changelogsClient = new ChangelogsClient();

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

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

static::changelogName

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

Parameters
Name
Description
project
string
location
string
agent
string
changelog
string
Returns
Type
Description
string
The formatted changelog 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}/locations/{location}/agents/{agent}
  • changelog: projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}

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.cx.v3.Changelogs' 
 

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.

Design a Mobile Site
View Site in Mobile | Classic
Share by: