Constructor
new IntentsClient(optionsopt)
Construct an instance of IntentsClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. See the subsequent parameters for more details. Properties
|
Members
(static) apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
(static) port
The port for this API service.
(static) scopes
The scopes needed to make gRPC calls for every method defined in this service.
(static) servicePath
The DNS address for this API service.
Methods
agentPath(project) → {string}
Return a fully-qualified agent resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
batchDeleteIntents(request, optionsopt) → {Promise}
Deletes intents in the specified agent.
Operation <response: google.protobuf.Empty>
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
batchUpdateIntents(request, optionsopt) → {Promise}
Updates/Creates multiple intents in the specified agent.
Operation <response: BatchUpdateIntentsResponse>
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
(async) checkBatchDeleteIntentsProgress(name) → {Promise}
Check the status of the long running operation returned by the batchDeleteIntents() method.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
(async) checkBatchUpdateIntentsProgress(name) → {Promise}
Check the status of the long running operation returned by the batchUpdateIntents() method.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
close()
Terminate the GRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
createIntent(request, optionsopt) → {Promise}
Creates an intent in the specified agent.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
deleteIntent(request, optionsopt) → {Promise}
Deletes the specified intent and its direct or indirect followup intents.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
entityTypePath(project, entity_type) → {string}
Return a fully-qualified entityType resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
entity_type |
string |
environmentPath(project, environment) → {string}
Return a fully-qualified environment resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
environment |
string |
getIntent(request, optionsopt) → {Promise}
Retrieves the specified intent.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
getProjectId(callback)
Return the project ID used by this class.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function |
the callback to be called with the current project Id. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
intentPath(project, intent) → {string}
Return a fully-qualified intent resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
intent |
string |
listIntents(request, optionsopt) → {Promise}
Returns the list of all intents in the specified agent.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
listIntentsAsync(request, optionsopt) → {Object}
Equivalent to listIntents, but returns an iterable object.
for-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
listIntentsStream(request, optionsopt) → {Stream}
Equivalent to listIntents, but returns a NodeJS Stream object.
This fetches the paged responses for listIntents continuously and invokes the callback registered for 'data' event for each element in the responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the context from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}
Parse the context from ProjectAgentSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentSessionContextName |
string |
A fully-qualified path representing project_agent_session_context resource. |
matchEntityTypeFromEntityTypeName(entityTypeName) → {string}
Parse the entity_type from EntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
entityTypeName |
string |
A fully-qualified path representing EntityType resource. |
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}
Parse the entity_type from ProjectAgentSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_session_entity_type resource. |
matchEnvironmentFromEnvironmentName(environmentName) → {string}
Parse the environment from Environment resource.
Parameters:
Name | Type | Description |
---|---|---|
environmentName |
string |
A fully-qualified path representing Environment resource. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
matchIntentFromIntentName(intentName) → {string}
Parse the intent from Intent resource.
Parameters:
Name | Type | Description |
---|---|---|
intentName |
string |
A fully-qualified path representing Intent resource. |
matchProjectFromAgentName(agentName) → {string}
Parse the project from Agent resource.
Parameters:
Name | Type | Description |
---|---|---|
agentName |
string |
A fully-qualified path representing Agent resource. |
matchProjectFromEntityTypeName(entityTypeName) → {string}
Parse the project from EntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
entityTypeName |
string |
A fully-qualified path representing EntityType resource. |
matchProjectFromEnvironmentName(environmentName) → {string}
Parse the project from Environment resource.
Parameters:
Name | Type | Description |
---|---|---|
environmentName |
string |
A fully-qualified path representing Environment resource. |
matchProjectFromIntentName(intentName) → {string}
Parse the project from Intent resource.
Parameters:
Name | Type | Description |
---|---|---|
intentName |
string |
A fully-qualified path representing Intent resource. |
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the project from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}
Parse the project from ProjectAgentSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentSessionContextName |
string |
A fully-qualified path representing project_agent_session_context resource. |
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}
Parse the project from ProjectAgentSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_session_entity_type resource. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
Name | Type | Description |
---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the session from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}
Parse the session from ProjectAgentSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentSessionContextName |
string |
A fully-qualified path representing project_agent_session_context resource. |
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}
Parse the session from ProjectAgentSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_session_entity_type resource. |
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the user from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context) → {string}
Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
environment |
string | |
user |
string | |
session |
string | |
context |
string |
projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entity_type) → {string}
Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
environment |
string | |
user |
string | |
session |
string | |
entity_type |
string |
projectAgentSessionContextPath(project, session, context) → {string}
Return a fully-qualified projectAgentSessionContext resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
session |
string | |
context |
string |
projectAgentSessionEntityTypePath(project, session, entity_type) → {string}
Return a fully-qualified projectAgentSessionEntityType resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
session |
string | |
entity_type |
string |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
updateIntent(request, optionsopt) → {Promise}
Updates the specified intent.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |