Google Cloud Dialogflow V2 Client - Class EntityTypesClient (1.9.0)

Version 1.9.0

• 1.17.0 (latest)
• 1.16.0
• 1.15.1
• 1.14.0
• 1.13.0
• 1.12.3
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.0
• 1.7.2
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.1
• 1.0.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Service Description: Service for managing EntityTypes.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Dialogflow \ V2 \ 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.

batchCreateEntities

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: An Empty message

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::batchCreateEntitiesAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchCreateEntitiesRequest 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

batchDeleteEntities

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: An Empty message

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::batchDeleteEntitiesAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchDeleteEntitiesRequest 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

batchDeleteEntityTypes

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: An Empty message

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::batchDeleteEntityTypesAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchDeleteEntityTypesRequest 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

batchUpdateEntities

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: An Empty message

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::batchUpdateEntitiesAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchUpdateEntitiesRequest 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

batchUpdateEntityTypes

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: An empty Struct message
• response: BatchUpdateEntityTypesResponse

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::batchUpdateEntityTypesAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchUpdateEntityTypesRequest 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

createEntityType

Creates an entity type in the specified agent.

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::createEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\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\V2\EntityType

deleteEntityType

Deletes the specified entity type.

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::deleteEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\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.

getEntityType

Retrieves the specified entity type.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\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\V2\EntityType

listEntityTypes

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listEntityTypesAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\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

updateEntityType

Updates the specified entity type.

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

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::updateEntityTypeAsync() .

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\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\V2\EntityType

getLocation

Gets information about a location.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::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

batchCreateEntitiesAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchCreateEntitiesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

batchDeleteEntitiesAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchDeleteEntitiesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

batchDeleteEntityTypesAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchDeleteEntityTypesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

batchUpdateEntitiesAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchUpdateEntitiesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

batchUpdateEntityTypesAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\BatchUpdateEntityTypesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\CreateEntityTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\DeleteEntityTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\GetEntityTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listEntityTypesAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\ListEntityTypesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateEntityTypeAsync

Parameters
Name	Description
request	Google\Cloud\Dialogflow\V2\UpdateEntityTypeRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

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

Returns
Type	Description
Google\ApiCore\LongRunning\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.

Parameter
Name	Description
project	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
entityType	string

Returns
Type	Description
string	The formatted entity_type 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::projectEntityTypeName

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

Parameters
Name	Description
project	string
entityType	string

Returns
Type	Description
string	The formatted project_entity_type 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::projectLocationEntityTypeName

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

Parameters
Name	Description
project	string
location	string
entityType	string

Returns
Type	Description
string	The formatted project_location_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}/agent
• entityType: projects/{project}/agent/entityTypes/{entity_type}
• projectAgent: projects/{project}/agent
• projectEntityType: projects/{project}/agent/entityTypes/{entity_type}
• projectLocationAgent: projects/{project}/locations/{location}/agent
• projectLocationEntityType: projects/{project}/locations/{location}/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.