Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ContextsClient.
Service Description: Service for managing Contexts.
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 \ V2 \ ClientMethods
__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 |
↳ 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 |
↳ 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. |
createContext
Creates a context.
If the specified context already exists, overrides the context.
The async variant is ContextsClient::createContextAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CreateContextRequest
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\Context |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\CreateContextRequest;
/**
* @param string $formattedParent The session to create a context 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 ContextsClient::sessionName()} for help formatting this field.
* @param string $contextName The unique identifier of the context. Format:
* `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
* or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
* ID>/sessions/<Session ID>/contexts/<Context ID>`.
*
* The `Context ID` is always converted to lowercase, may only contain
* characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long.
*
* If `Environment ID` is not specified, we assume default 'draft'
* environment. If `User ID` is not specified, we assume default '-' user.
*
* The following context names are reserved for internal use by Dialogflow.
* You should not use these contexts or create contexts with these names:
*
* * `__system_counters__`
* * `*_id_dialog_context`
* * `*_dialog_params_size`
*/
function create_context_sample(string $formattedParent, string $contextName): void
{
// Create a client.
$contextsClient = new ContextsClient();
// Prepare the request message.
$context = (new Context())
->setName($contextName);
$request = (new CreateContextRequest())
->setParent($formattedParent)
->setContext($context);
// Call the API and handle any network failures.
try {
/** @var Context $response */
$response = $contextsClient->createContext($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 = ContextsClient::sessionName('[PROJECT]', '[SESSION]');
$contextName = '[NAME]';
create_context_sample($formattedParent, $contextName);
}
deleteAllContexts
Deletes all active contexts in the specified session.
The async variant is ContextsClient::deleteAllContextsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\DeleteAllContextsRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\DeleteAllContextsRequest;
/**
* @param string $formattedParent The name of the session to delete all contexts 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 ContextsClient::sessionName()} for help formatting this field.
*/
function delete_all_contexts_sample(string $formattedParent): void
{
// Create a client.
$contextsClient = new ContextsClient();
// Prepare the request message.
$request = (new DeleteAllContextsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
$contextsClient->deleteAllContexts($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
{
$formattedParent = ContextsClient::sessionName('[PROJECT]', '[SESSION]');
delete_all_contexts_sample($formattedParent);
}
deleteContext
Deletes the specified context.
The async variant is ContextsClient::deleteContextAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\DeleteContextRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\DeleteContextRequest;
/**
* @param string $formattedName The name of the context to delete. Format:
* `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
* or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
* ID>/sessions/<Session ID>/contexts/<Context 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 ContextsClient::contextName()} for help formatting this field.
*/
function delete_context_sample(string $formattedName): void
{
// Create a client.
$contextsClient = new ContextsClient();
// Prepare the request message.
$request = (new DeleteContextRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$contextsClient->deleteContext($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 = ContextsClient::contextName('[PROJECT]', '[SESSION]', '[CONTEXT]');
delete_context_sample($formattedName);
}
getContext
Retrieves the specified context.
The async variant is ContextsClient::getContextAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GetContextRequest
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\Context |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\GetContextRequest;
/**
* @param string $formattedName The name of the context. Format:
* `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`
* or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
* ID>/sessions/<Session ID>/contexts/<Context 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 ContextsClient::contextName()} for help formatting this field.
*/
function get_context_sample(string $formattedName): void
{
// Create a client.
$contextsClient = new ContextsClient();
// Prepare the request message.
$request = (new GetContextRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Context $response */
$response = $contextsClient->getContext($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 = ContextsClient::contextName('[PROJECT]', '[SESSION]', '[CONTEXT]');
get_context_sample($formattedName);
}
listContexts
Returns the list of all contexts in the specified session.
The async variant is ContextsClient::listContextsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListContextsRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\ListContextsRequest;
/**
* @param string $formattedParent The session to list all contexts 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 ContextsClient::sessionName()} for help formatting this field.
*/
function list_contexts_sample(string $formattedParent): void
{
// Create a client.
$contextsClient = new ContextsClient();
// Prepare the request message.
$request = (new ListContextsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $contextsClient->listContexts($request);
/** @var Context $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 = ContextsClient::sessionName('[PROJECT]', '[SESSION]');
list_contexts_sample($formattedParent);
}
updateContext
Updates the specified context.
The async variant is ContextsClient::updateContextAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\UpdateContextRequest
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\Context |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
use Google\Cloud\Dialogflow\V2\Context;
use Google\Cloud\Dialogflow\V2\UpdateContextRequest;
/**
* @param string $contextName The unique identifier of the context. Format:
* `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
* or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
* ID>/sessions/<Session ID>/contexts/<Context ID>`.
*
* The `Context ID` is always converted to lowercase, may only contain
* characters in `a-zA-Z0-9_-%` and may be at most 250 bytes long.
*
* If `Environment ID` is not specified, we assume default 'draft'
* environment. If `User ID` is not specified, we assume default '-' user.
*
* The following context names are reserved for internal use by Dialogflow.
* You should not use these contexts or create contexts with these names:
*
* * `__system_counters__`
* * `*_id_dialog_context`
* * `*_dialog_params_size`
*/
function update_context_sample(string $contextName): void
{
// Create a client.
$contextsClient = new ContextsClient();
// Prepare the request message.
$context = (new Context())
->setName($contextName);
$request = (new UpdateContextRequest())
->setContext($context);
// Call the API and handle any network failures.
try {
/** @var Context $response */
$response = $contextsClient->updateContext($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
{
$contextName = '[NAME]';
update_context_sample($contextName);
}
getLocation
Gets information about a location.
The async variant is ContextsClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
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.
$contextsClient = new ContextsClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $contextsClient->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 ContextsClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dialogflow\V2\Client\ContextsClient;
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.
$contextsClient = new ContextsClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $contextsClient->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());
}
}
createContextAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\CreateContextRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Context> |
deleteAllContextsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\DeleteAllContextsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
deleteContextAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\DeleteContextRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getContextAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\GetContextRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Context> |
listContextsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\ListContextsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
updateContextAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dialogflow\V2\UpdateContextRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\V2\Context> |
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> |
static::contextName
Formats a string containing the fully-qualified path to represent a context resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
session |
string
|
context |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted context resource. |
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::projectEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_environment_user_session_context resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
environment |
string
|
user |
string
|
session |
string
|
context |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_environment_user_session_context 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::projectLocationEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session_context resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
environment |
string
|
user |
string
|
session |
string
|
context |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_environment_user_session_context 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::projectLocationSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_session_context resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
session |
string
|
context |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_location_session_context 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::projectSessionContextName
Formats a string containing the fully-qualified path to represent a project_session_context resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
session |
string
|
context |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted project_session_context 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::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
- context: projects/{project}/agent/sessions/{session}/contexts/{context}
- projectEnvironmentUserSession: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}
- projectEnvironmentUserSessionContext: projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
- projectLocationEnvironmentUserSession: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}
- projectLocationEnvironmentUserSessionContext: projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}
- projectLocationSession: projects/{project}/locations/{location}/agent/sessions/{session}
- projectLocationSessionContext: projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}
- projectSession: projects/{project}/agent/sessions/{session}
- projectSessionContext: projects/{project}/agent/sessions/{session}/contexts/{context}
- session: projects/{project}/agent/sessions/{session}
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. |