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

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

Service Description: Service for managing Webhooks.

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:

$webhooksClient = new WebhooksClient();
try {
    $formattedParent = $webhooksClient->agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $webhook = new Webhook();
    $response = $webhooksClient->createWebhook($formattedParent, $webhook);
} finally {
    $webhooksClient->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.

createWebhook

Creates a webhook in the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to create a webhook for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`webhook`	`Google\Cloud\Dialogflow\Cx\V3\Webhook` Required. The webhook 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\Cx\V3\Webhook`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Webhook;
use Google\Cloud\Dialogflow\Cx\V3\WebhooksClient;

/**
 * @param string $formattedParent    The agent to create a webhook for.
 *                                   Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                   {@see WebhooksClient::agentName()} for help formatting this field.
 * @param string $webhookDisplayName The human-readable name of the webhook, unique within the agent.
 */
function create_webhook_sample(string $formattedParent, string $webhookDisplayName): void
{
    // Create a client.
    $webhooksClient = new WebhooksClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $webhook = (new Webhook())
        ->setDisplayName($webhookDisplayName);

    // Call the API and handle any network failures.
    try {
        /** @var Webhook $response */
        $response = $webhooksClient->createWebhook($formattedParent, $webhook);
        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 = WebhooksClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $webhookDisplayName = '[DISPLAY_NAME]';

    create_webhook_sample($formattedParent, $webhookDisplayName);
}

deleteWebhook

Deletes the specified webhook.

Parameters
Name	Description
`name`	`string` Required. The name of the webhook to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook ID>`.
`optionalArgs`	`array` Optional.
`↳ force`	`bool` This field has no effect for webhook not being used. For webhooks that are used by pages/flows/transition route groups: * If `force` is set to false, an error will be returned with message indicating the referenced resources. * If `force` is set to true, Dialogflow will remove the webhook, as well as any references to the webhook (i.e. Webhook and tagin fulfillments that point to this webhook will be removed).
`↳ 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\Cx\V3\WebhooksClient;

/**
 * @param string $formattedName The name of the webhook to delete.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/webhooks/<Webhook ID>`. Please see
 *                              {@see WebhooksClient::webhookName()} for help formatting this field.
 */
function delete_webhook_sample(string $formattedName): void
{
    // Create a client.
    $webhooksClient = new WebhooksClient();

    // Call the API and handle any network failures.
    try {
        $webhooksClient->deleteWebhook($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 = WebhooksClient::webhookName('[PROJECT]', '[LOCATION]', '[AGENT]', '[WEBHOOK]');

    delete_webhook_sample($formattedName);
}

getWebhook

Retrieves the specified webhook.

Parameters
Name	Description
`name`	`string` Required. The name of the webhook. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/webhooks/<Webhook 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\Cx\V3\Webhook`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Webhook;
use Google\Cloud\Dialogflow\Cx\V3\WebhooksClient;

/**
 * @param string $formattedName The name of the webhook.
 *                              Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 *                              ID>/webhooks/<Webhook ID>`. Please see
 *                              {@see WebhooksClient::webhookName()} for help formatting this field.
 */
function get_webhook_sample(string $formattedName): void
{
    // Create a client.
    $webhooksClient = new WebhooksClient();

    // Call the API and handle any network failures.
    try {
        /** @var Webhook $response */
        $response = $webhooksClient->getWebhook($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 = WebhooksClient::webhookName('[PROJECT]', '[LOCATION]', '[AGENT]', '[WEBHOOK]');

    get_webhook_sample($formattedName);
}

listWebhooks

Returns the list of all webhooks in the specified agent.

Parameters
Name	Description
`parent`	`string` Required. The agent to list all webhooks for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
`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\Cx\V3\Webhook;
use Google\Cloud\Dialogflow\Cx\V3\WebhooksClient;

/**
 * @param string $formattedParent The agent to list all webhooks for.
 *                                Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`. Please see
 *                                {@see WebhooksClient::agentName()} for help formatting this field.
 */
function list_webhooks_sample(string $formattedParent): void
{
    // Create a client.
    $webhooksClient = new WebhooksClient();

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

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

    list_webhooks_sample($formattedParent);
}

updateWebhook

Updates the specified webhook.

Parameters
Name	Description
`webhook`	`Google\Cloud\Dialogflow\Cx\V3\Webhook` Required. The webhook to update.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` The mask to control which fields get updated. If the mask is not present, all fields will be updated.
`↳ 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\Cx\V3\Webhook`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Webhook;
use Google\Cloud\Dialogflow\Cx\V3\WebhooksClient;

/**
 * @param string $webhookDisplayName The human-readable name of the webhook, unique within the agent.
 */
function update_webhook_sample(string $webhookDisplayName): void
{
    // Create a client.
    $webhooksClient = new WebhooksClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $webhook = (new Webhook())
        ->setDisplayName($webhookDisplayName);

    // Call the API and handle any network failures.
    try {
        /** @var Webhook $response */
        $response = $webhooksClient->updateWebhook($webhook);
        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
{
    $webhookDisplayName = '[DISPLAY_NAME]';

    update_webhook_sample($webhookDisplayName);
}

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\Cx\V3\WebhooksClient;
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.
    $webhooksClient = new WebhooksClient();

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

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

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`namespace`	`string`
`service`	`string`

Returns
Type	Description
`string`	The formatted service resource.

static::webhookName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`agent`	`string`
`webhook`	`string`

Returns
Type	Description
`string`	The formatted webhook 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}
service: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}
webhook: projects/{project}/locations/{location}/agents/{agent}/webhooks/{webhook}

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.Webhooks'

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.