Google Cloud Dialogflow Cx V3 Client - Class EntityTypesClient (0.5.1)

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

Service Description: Service for managing EntityTypes.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

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 \ Client

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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

createEntityType

Creates an entity type in the specified agent.

Note: You should always train a flow prior to sending it queries. See the training documentation.

The async variant is EntityTypesClient::createEntityTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\CreateEntityTypeRequest` A request to house fields associated with the call.
`callOptions`	`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\EntityType`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateEntityTypeRequest;
use Google\Cloud\Dialogflow\Cx\V3\EntityType;
use Google\Cloud\Dialogflow\Cx\V3\EntityType\Kind;

/**
 * @param string $formattedParent       The agent to create a entity type for.
 *                                      Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                      {@see EntityTypesClient::agentName()} for help formatting this field.
 * @param string $entityTypeDisplayName The human-readable name of the entity type, unique within the
 *                                      agent.
 * @param int    $entityTypeKind        Indicates the kind of entity type.
 */
function create_entity_type_sample(
    string $formattedParent,
    string $entityTypeDisplayName,
    int $entityTypeKind
): void {
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entityType = (new EntityType())
        ->setDisplayName($entityTypeDisplayName)
        ->setKind($entityTypeKind);
    $request = (new CreateEntityTypeRequest())
        ->setParent($formattedParent)
        ->setEntityType($entityType);

    // Call the API and handle any network failures.
    try {
        /** @var EntityType $response */
        $response = $entityTypesClient->createEntityType($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
{
    $formattedParent = EntityTypesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $entityTypeDisplayName = '[DISPLAY_NAME]';
    $entityTypeKind = Kind::KIND_UNSPECIFIED;

    create_entity_type_sample($formattedParent, $entityTypeDisplayName, $entityTypeKind);
}

deleteEntityType

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation.

The async variant is EntityTypesClient::deleteEntityTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\DeleteEntityTypeRequest` A request to house fields associated with the call.
`callOptions`	`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\Cx\V3\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteEntityTypeRequest;

/**
 * @param string $formattedName The name of the entity type to delete.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`. Please see
 *                              {@see EntityTypesClient::entityTypeName()} for help formatting this field.
 */
function delete_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

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

    // Call the API and handle any network failures.
    try {
        $entityTypesClient->deleteEntityType($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 = EntityTypesClient::entityTypeName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENTITY_TYPE]'
    );

    delete_entity_type_sample($formattedName);
}

exportEntityTypes

Exports the selected entity types.

The async variant is EntityTypesClient::exportEntityTypesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ExportEntityTypesRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\Cx\V3\ExportEntityTypesRequest;
use Google\Cloud\Dialogflow\Cx\V3\ExportEntityTypesResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent    The name of the parent agent to export entity types.
 *                                   Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                   {@see EntityTypesClient::agentName()} for help formatting this field.
 * @param string $entityTypesElement The name of the entity types to export.
 *                                   Format:
 *                                   `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.
 */
function export_entity_types_sample(string $formattedParent, string $entityTypesElement): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entityTypes = [$entityTypesElement,];
    $request = (new ExportEntityTypesRequest())
        ->setParent($formattedParent)
        ->setEntityTypes($entityTypes);

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

        if ($response->operationSucceeded()) {
            /** @var ExportEntityTypesResponse $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 = EntityTypesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $entityTypesElement = '[ENTITY_TYPES]';

    export_entity_types_sample($formattedParent, $entityTypesElement);
}

getEntityType

Retrieves the specified entity type.

The async variant is EntityTypesClient::getEntityTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetEntityTypeRequest` A request to house fields associated with the call.
`callOptions`	`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\EntityType`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\Cx\V3\EntityType;
use Google\Cloud\Dialogflow\Cx\V3\GetEntityTypeRequest;

/**
 * @param string $formattedName The name of the entity type.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`. Please see
 *                              {@see EntityTypesClient::entityTypeName()} for help formatting this field.
 */
function get_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var EntityType $response */
        $response = $entityTypesClient->getEntityType($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 = EntityTypesClient::entityTypeName(
        '[PROJECT]',
        '[LOCATION]',
        '[AGENT]',
        '[ENTITY_TYPE]'
    );

    get_entity_type_sample($formattedName);
}

importEntityTypes

Imports the specified entitytypes into the agent.

The async variant is EntityTypesClient::importEntityTypesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ImportEntityTypesRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\Cx\V3\ImportEntityTypesRequest;
use Google\Cloud\Dialogflow\Cx\V3\ImportEntityTypesRequest\MergeOption;
use Google\Cloud\Dialogflow\Cx\V3\ImportEntityTypesResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The agent to import the entity types into.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see EntityTypesClient::agentName()} for help formatting this field.
 * @param int    $mergeOption     Merge option for importing entity types.
 */
function import_entity_types_sample(string $formattedParent, int $mergeOption): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

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

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

        if ($response->operationSucceeded()) {
            /** @var ImportEntityTypesResponse $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 = EntityTypesClient::agentName('[PROJECT]', '[LOCATION]', '[AGENT]');
    $mergeOption = MergeOption::MERGE_OPTION_UNSPECIFIED;

    import_entity_types_sample($formattedParent, $mergeOption);
}

listEntityTypes

Returns the list of all entity types in the specified agent.

The async variant is EntityTypesClient::listEntityTypesAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ListEntityTypesRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\Cx\V3\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\Cx\V3\EntityType;
use Google\Cloud\Dialogflow\Cx\V3\ListEntityTypesRequest;

/**
 * @param string $formattedParent The agent to list all entity types for.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`. Please see
 *                                {@see EntityTypesClient::agentName()} for help formatting this field.
 */
function list_entity_types_sample(string $formattedParent): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

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

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

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

    list_entity_types_sample($formattedParent);
}

updateEntityType

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the training documentation.

The async variant is EntityTypesClient::updateEntityTypeAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateEntityTypeRequest` A request to house fields associated with the call.
`callOptions`	`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\EntityType`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\EntityTypesClient;
use Google\Cloud\Dialogflow\Cx\V3\EntityType;
use Google\Cloud\Dialogflow\Cx\V3\EntityType\Kind;
use Google\Cloud\Dialogflow\Cx\V3\UpdateEntityTypeRequest;

/**
 * @param string $entityTypeDisplayName The human-readable name of the entity type, unique within the
 *                                      agent.
 * @param int    $entityTypeKind        Indicates the kind of entity type.
 */
function update_entity_type_sample(string $entityTypeDisplayName, int $entityTypeKind): void
{
    // Create a client.
    $entityTypesClient = new EntityTypesClient();

    // Prepare the request message.
    $entityType = (new EntityType())
        ->setDisplayName($entityTypeDisplayName)
        ->setKind($entityTypeKind);
    $request = (new UpdateEntityTypeRequest())
        ->setEntityType($entityType);

    // Call the API and handle any network failures.
    try {
        /** @var EntityType $response */
        $response = $entityTypesClient->updateEntityType($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
{
    $entityTypeDisplayName = '[DISPLAY_NAME]';
    $entityTypeKind = Kind::KIND_UNSPECIFIED;

    update_entity_type_sample($entityTypeDisplayName, $entityTypeKind);
}

getLocation

Gets information about a location.

The async variant is EntityTypesClient::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`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\Location\Location`

Example

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

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

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

The async variant is EntityTypesClient::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

Example

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

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

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

createEntityTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\CreateEntityTypeRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\EntityType>`

deleteEntityTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\DeleteEntityTypeRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

exportEntityTypesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ExportEntityTypesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getEntityTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetEntityTypeRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\EntityType>`

importEntityTypesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ImportEntityTypesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

listEntityTypesAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ListEntityTypesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

updateEntityTypeAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateEntityTypeRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\EntityType>`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\LongRunning\Client\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

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::entityTypeName

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

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

Returns
Type	Description
`string`	The formatted entity_type 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}
entityType: projects/{project}/locations/{location}/agents/{agent}/entityTypes/{entity_type}

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.