Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class ContextsClient.
Service Description: Service for managing Contexts .
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Dialogflow \ V2 \ ClientMethods
__construct
Constructor.
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.
createContext
Creates a context.
If the specified context already exists, overrides the context.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::createContextAsync() .
request
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.
deleteAllContexts
Deletes all active contexts in the specified session.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::deleteAllContextsAsync() .
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.
deleteContext
Deletes the specified context.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::deleteContextAsync() .
request
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.
getContext
Retrieves the specified context.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getContextAsync() .
request
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.
listContexts
Returns the list of all contexts in the specified session.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listContextsAsync() .
request
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.
updateContext
Updates the specified context.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::updateContextAsync() .
request
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::getLocationAsync() .
request
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\Dialogflow\V2\Client\BaseClient\self::listLocationsAsync() .
request
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.
createContextAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteAllContextsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteContextAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getContextAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listContextsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateContextAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::contextName
Formats a string containing the fully-qualified path to represent a context resource.
project
string
session
string
context
string
string
static::projectEnvironmentUserSessionName
Formats a string containing the fully-qualified path to represent a project_environment_user_session resource.
project
string
environment
string
user
string
session
string
string
static::projectEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_environment_user_session_context resource.
project
string
environment
string
user
string
session
string
context
string
string
static::projectLocationEnvironmentUserSessionName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session resource.
project
string
location
string
environment
string
user
string
session
string
string
static::projectLocationEnvironmentUserSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_environment_user_session_context resource.
project
string
location
string
environment
string
user
string
session
string
context
string
string
static::projectLocationSessionName
Formats a string containing the fully-qualified path to represent a project_location_session resource.
project
string
location
string
session
string
string
static::projectLocationSessionContextName
Formats a string containing the fully-qualified path to represent a project_location_session_context resource.
project
string
location
string
session
string
context
string
string
static::projectSessionName
Formats a string containing the fully-qualified path to represent a project_session resource.
project
string
session
string
string
static::projectSessionContextName
Formats a string containing the fully-qualified path to represent a project_session_context resource.
project
string
session
string
context
string
string
static::sessionName
Formats a string containing the fully-qualified path to represent a session resource.
project
string
session
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
