Google Cloud Dialogflow V2 Client - Class SessionEntityTypesClient (1.5.0)

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

Service Description: Service for managing SessionEntityTypes.

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:

$sessionEntityTypesClient = new SessionEntityTypesClient();
try {
    $formattedParent = $sessionEntityTypesClient->sessionName('[PROJECT]', '[SESSION]');
    $sessionEntityType = new SessionEntityType();
    $response = $sessionEntityTypesClient->createSessionEntityType($formattedParent, $sessionEntityType);
} finally {
    $sessionEntityTypesClient->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 \ 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.

createSessionEntityType

Creates a session entity type.

If the specified session entity type already exists, overrides the session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`parent`	`string` Required. The session to create a session entity type for. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
`sessionEntityType`	`Google\Cloud\Dialogflow\V2\SessionEntityType` Required. The session entity type 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\SessionEntityType`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\EntityType\Entity;
use Google\Cloud\Dialogflow\V2\SessionEntityType;
use Google\Cloud\Dialogflow\V2\SessionEntityType\EntityOverrideMode;
use Google\Cloud\Dialogflow\V2\SessionEntityTypesClient;

/**
 * @param string $formattedParent                          The session to create a session entity type for.
 *                                                         Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
 *                                                         `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/
 *                                                         sessions/<Session ID>`.
 *                                                         If `Environment ID` is not specified, we assume default 'draft'
 *                                                         environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                                                         {@see SessionEntityTypesClient::sessionName()} for help formatting this field.
 * @param string $sessionEntityTypeName                    The unique identifier of this session entity type. Format:
 *                                                         `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                                                         Display Name>`, or `projects/<Project ID>/agent/environments/<Environment
 *                                                         ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                                                         Name>`.
 *                                                         If `Environment ID` is not specified, we assume default 'draft'
 *                                                         environment. If `User ID` is not specified, we assume default '-' user.
 *
 *                                                         `<Entity Type Display Name>` must be the display name of an existing entity
 *                                                         type in the same agent that will be overridden or supplemented.
 * @param int    $sessionEntityTypeEntityOverrideMode      Indicates whether the additional data should override or
 *                                                         supplement the custom entity type definition.
 * @param string $sessionEntityTypeEntitiesValue           The primary value associated with this entity entry.
 *                                                         For example, if the entity type is *vegetable*, the value could be
 *                                                         *scallions*.
 *
 *                                                         For `KIND_MAP` entity types:
 *
 *                                                         *   A reference value to be used in place of synonyms.
 *
 *                                                         For `KIND_LIST` entity types:
 *
 *                                                         *   A string that can contain references to other entity types (with or
 *                                                         without aliases).
 * @param string $sessionEntityTypeEntitiesSynonymsElement A collection of value synonyms. For example, if the entity type
 *                                                         is *vegetable*, and `value` is *scallions*, a synonym could be *green
 *                                                         onions*.
 *
 *                                                         For `KIND_LIST` entity types:
 *
 *                                                         *   This collection must contain exactly one synonym equal to `value`.
 */
function create_session_entity_type_sample(
    string $formattedParent,
    string $sessionEntityTypeName,
    int $sessionEntityTypeEntityOverrideMode,
    string $sessionEntityTypeEntitiesValue,
    string $sessionEntityTypeEntitiesSynonymsElement
): void {
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $sessionEntityTypeEntitiesSynonyms = [$sessionEntityTypeEntitiesSynonymsElement,];
    $entity = (new Entity())
        ->setValue($sessionEntityTypeEntitiesValue)
        ->setSynonyms($sessionEntityTypeEntitiesSynonyms);
    $sessionEntityTypeEntities = [$entity,];
    $sessionEntityType = (new SessionEntityType())
        ->setName($sessionEntityTypeName)
        ->setEntityOverrideMode($sessionEntityTypeEntityOverrideMode)
        ->setEntities($sessionEntityTypeEntities);

    // Call the API and handle any network failures.
    try {
        /** @var SessionEntityType $response */
        $response = $sessionEntityTypesClient->createSessionEntityType(
            $formattedParent,
            $sessionEntityType
        );
        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 = SessionEntityTypesClient::sessionName('[PROJECT]', '[SESSION]');
    $sessionEntityTypeName = '[NAME]';
    $sessionEntityTypeEntityOverrideMode = EntityOverrideMode::ENTITY_OVERRIDE_MODE_UNSPECIFIED;
    $sessionEntityTypeEntitiesValue = '[VALUE]';
    $sessionEntityTypeEntitiesSynonymsElement = '[SYNONYMS]';

    create_session_entity_type_sample(
        $formattedParent,
        $sessionEntityTypeName,
        $sessionEntityTypeEntityOverrideMode,
        $sessionEntityTypeEntitiesValue,
        $sessionEntityTypeEntitiesSynonymsElement
    );
}

deleteSessionEntityType

Deletes the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`name`	`string` Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
`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\SessionEntityTypesClient;

/**
 * @param string $formattedName The name of the entity type to delete. Format:
 *                              `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                              Display Name>` or `projects/<Project ID>/agent/environments/<Environment
 *                              ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                              Name>`.
 *                              If `Environment ID` is not specified, we assume default 'draft'
 *                              environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                              {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field.
 */
function delete_session_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

    // Call the API and handle any network failures.
    try {
        $sessionEntityTypesClient->deleteSessionEntityType($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 = SessionEntityTypesClient::sessionEntityTypeName(
        '[PROJECT]',
        '[SESSION]',
        '[ENTITY_TYPE]'
    );

    delete_session_entity_type_sample($formattedName);
}

getSessionEntityType

Retrieves the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`name`	`string` Required. The name of the session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
`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\SessionEntityType`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\SessionEntityType;
use Google\Cloud\Dialogflow\V2\SessionEntityTypesClient;

/**
 * @param string $formattedName The name of the session entity type. Format:
 *                              `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                              Display Name>` or `projects/<Project ID>/agent/environments/<Environment
 *                              ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                              Name>`.
 *                              If `Environment ID` is not specified, we assume default 'draft'
 *                              environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                              {@see SessionEntityTypesClient::sessionEntityTypeName()} for help formatting this field.
 */
function get_session_entity_type_sample(string $formattedName): void
{
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

    // Call the API and handle any network failures.
    try {
        /** @var SessionEntityType $response */
        $response = $sessionEntityTypesClient->getSessionEntityType($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 = SessionEntityTypesClient::sessionEntityTypeName(
        '[PROJECT]',
        '[SESSION]',
        '[ENTITY_TYPE]'
    );

    get_session_entity_type_sample($formattedName);
}

listSessionEntityTypes

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

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`parent`	`string` Required. The session to list all session entity types from. Format: `projects/<Project ID>/agent/sessions/<Session ID>` or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/ sessions/<Session ID>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user.
`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\SessionEntityType;
use Google\Cloud\Dialogflow\V2\SessionEntityTypesClient;

/**
 * @param string $formattedParent The session to list all session entity types from.
 *                                Format: `projects/<Project ID>/agent/sessions/<Session ID>` or
 *                                `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/
 *                                sessions/<Session ID>`.
 *                                If `Environment ID` is not specified, we assume default 'draft'
 *                                environment. If `User ID` is not specified, we assume default '-' user. Please see
 *                                {@see SessionEntityTypesClient::sessionName()} for help formatting this field.
 */
function list_session_entity_types_sample(string $formattedParent): void
{
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

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

        /** @var SessionEntityType $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 = SessionEntityTypesClient::sessionName('[PROJECT]', '[SESSION]');

    list_session_entity_types_sample($formattedParent);
}

updateSessionEntityType

Updates the specified session entity type.

This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration.

Parameters
Name	Description
`sessionEntityType`	`Google\Cloud\Dialogflow\V2\SessionEntityType` Required. The session entity type to update.
`optionalArgs`	`array` Optional.
`↳ updateMask`	`FieldMask` Optional. The mask to control which fields get 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\V2\SessionEntityType`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\EntityType\Entity;
use Google\Cloud\Dialogflow\V2\SessionEntityType;
use Google\Cloud\Dialogflow\V2\SessionEntityType\EntityOverrideMode;
use Google\Cloud\Dialogflow\V2\SessionEntityTypesClient;

/**
 * @param string $sessionEntityTypeName                    The unique identifier of this session entity type. Format:
 *                                                         `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
 *                                                         Display Name>`, or `projects/<Project ID>/agent/environments/<Environment
 *                                                         ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display
 *                                                         Name>`.
 *                                                         If `Environment ID` is not specified, we assume default 'draft'
 *                                                         environment. If `User ID` is not specified, we assume default '-' user.
 *
 *                                                         `<Entity Type Display Name>` must be the display name of an existing entity
 *                                                         type in the same agent that will be overridden or supplemented.
 * @param int    $sessionEntityTypeEntityOverrideMode      Indicates whether the additional data should override or
 *                                                         supplement the custom entity type definition.
 * @param string $sessionEntityTypeEntitiesValue           The primary value associated with this entity entry.
 *                                                         For example, if the entity type is *vegetable*, the value could be
 *                                                         *scallions*.
 *
 *                                                         For `KIND_MAP` entity types:
 *
 *                                                         *   A reference value to be used in place of synonyms.
 *
 *                                                         For `KIND_LIST` entity types:
 *
 *                                                         *   A string that can contain references to other entity types (with or
 *                                                         without aliases).
 * @param string $sessionEntityTypeEntitiesSynonymsElement A collection of value synonyms. For example, if the entity type
 *                                                         is *vegetable*, and `value` is *scallions*, a synonym could be *green
 *                                                         onions*.
 *
 *                                                         For `KIND_LIST` entity types:
 *
 *                                                         *   This collection must contain exactly one synonym equal to `value`.
 */
function update_session_entity_type_sample(
    string $sessionEntityTypeName,
    int $sessionEntityTypeEntityOverrideMode,
    string $sessionEntityTypeEntitiesValue,
    string $sessionEntityTypeEntitiesSynonymsElement
): void {
    // Create a client.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $sessionEntityTypeEntitiesSynonyms = [$sessionEntityTypeEntitiesSynonymsElement,];
    $entity = (new Entity())
        ->setValue($sessionEntityTypeEntitiesValue)
        ->setSynonyms($sessionEntityTypeEntitiesSynonyms);
    $sessionEntityTypeEntities = [$entity,];
    $sessionEntityType = (new SessionEntityType())
        ->setName($sessionEntityTypeName)
        ->setEntityOverrideMode($sessionEntityTypeEntityOverrideMode)
        ->setEntities($sessionEntityTypeEntities);

    // Call the API and handle any network failures.
    try {
        /** @var SessionEntityType $response */
        $response = $sessionEntityTypesClient->updateSessionEntityType($sessionEntityType);
        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
{
    $sessionEntityTypeName = '[NAME]';
    $sessionEntityTypeEntityOverrideMode = EntityOverrideMode::ENTITY_OVERRIDE_MODE_UNSPECIFIED;
    $sessionEntityTypeEntitiesValue = '[VALUE]';
    $sessionEntityTypeEntitiesSynonymsElement = '[SYNONYMS]';

    update_session_entity_type_sample(
        $sessionEntityTypeName,
        $sessionEntityTypeEntityOverrideMode,
        $sessionEntityTypeEntitiesValue,
        $sessionEntityTypeEntitiesSynonymsElement
    );
}

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\SessionEntityTypesClient;
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.
    $sessionEntityTypesClient = new SessionEntityTypesClient();

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

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

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

Parameters
Name	Description
`project`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_environment_user_session resource.

static::projectEnvironmentUserSessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted project_environment_user_session_entity_type resource.

static::projectLocationEnvironmentUserSessionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_location_environment_user_session resource.

static::projectLocationEnvironmentUserSessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`environment`	`string`
`user`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted project_location_environment_user_session_entity_type resource.

static::projectLocationSessionName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_location_session resource.

static::projectLocationSessionEntityTypeName

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

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

Returns
Type	Description
`string`	The formatted project_location_session_entity_type resource.

static::projectSessionName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted project_session resource.

static::projectSessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted project_session_entity_type resource.

static::sessionName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`

Returns
Type	Description
`string`	The formatted session resource.

static::sessionEntityTypeName

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

Parameters
Name	Description
`project`	`string`
`session`	`string`
`entityType`	`string`

Returns
Type	Description
`string`	The formatted session_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

projectEnvironmentUserSession: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
projectEnvironmentUserSessionEntityType: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projectLocationEnvironmentUserSession: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}
projectLocationEnvironmentUserSessionEntityType: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}
projectLocationSession: projects/{project}/locations/{location}/agent/sessions/{session}
projectLocationSessionEntityType: projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}
projectSession: projects/{project}/agent/sessions/{session}
projectSessionEntityType: projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}
session: projects/{project}/agent/sessions/{session}
sessionEntityType: projects/{project}/agent/sessions/{session}/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.

Constants

SERVICE_NAME

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

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.