Service for managing . v2
Package
@google-cloud/dialogflow!Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);Construct an instance of EnvironmentsClient.
| Name | Description |
| opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
| Type | Description |
| string |
auth
auth: gax.GoogleAuth;| Type | Description |
| gax.GoogleAuth |
descriptors
descriptors: Descriptors;| Type | Description |
| Descriptors |
environmentsStub
environmentsStub?: Promise<{
[name: string]: Function;
}>;| Type | Description |
| Promise<{ [name: string]: Function; }> |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};| Type | Description |
| { [name: string]: Function; } |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};| Type | Description |
| { [name: string]: gax.PathTemplate; } |
port
static get port(): number;The port for this API service.
| Type | Description |
| number |
scopes
static get scopes(): string[];The scopes needed to make gRPC calls for every method defined in this service.
| Type | Description |
| string[] |
servicePath
static get servicePath(): string;The DNS address for this API service.
| Type | Description |
| string |
Methods
agentPath(project)
agentPath(project: string): string;Return a fully-qualified agent resource name string.
| Name | Description |
| project |
string
|
| Type | Description |
| string | {string} Resource name string. |
close()
close(): Promise<void>;Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
| Type | Description |
| Promise<void> | {Promise} A promise that resolves when the client is closed. |
entityTypePath(project, entityType)
entityTypePath(project: string, entityType: string): string;Return a fully-qualified entityType resource name string.
| Name | Description |
| project |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
environmentPath(project, environment)
environmentPath(project: string, environment: string): string;Return a fully-qualified environment resource name string.
| Name | Description |
| project |
string
|
| environment |
string
|
| Type | Description |
| string | {string} Resource name string. |
getProjectId()
getProjectId(): Promise<string>;| Type | Description |
| Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;| Name | Description |
| callback |
Callback<string, undefined, undefined>
|
| Type | Description |
| void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;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.
| Type | Description |
| Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
intentPath(project, intent)
intentPath(project: string, intent: string): string;Return a fully-qualified intent resource name string.
| Name | Description |
| project |
string
|
| intent |
string
|
| Type | Description |
| string | {string} Resource name string. |
listEnvironments(request, options)
listEnvironments(request: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2.IEnvironment[], protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest | null, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse]>;| Name | Description |
| request |
protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest
|
| options |
CallOptions
|
| Type | Description |
| Promise<[protos.google.cloud.dialogflow.v2.IEnvironment[], protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest | null, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse]> |
listEnvironments(request, options, callback)
listEnvironments(request: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>): void;| Name | Description |
| request |
protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest
|
| options |
CallOptions
|
| callback |
PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>
|
| Type | Description |
| void |
listEnvironments(request, callback)
listEnvironments(request: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>): void;| Name | Description |
| request |
protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest
|
| callback |
PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>
|
| Type | Description |
| void |
listEnvironmentsAsync(request, options)
listEnvironmentsAsync(request?: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IEnvironment>;Equivalent to listEnvironments, but returns an iterable object.
for-await-of syntax is used with the iterable to get response elements on-demand.
| Name | Description |
| request |
protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest
The request object that will be sent. |
| options |
CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| AsyncIterable<protos.google.cloud.dialogflow.v2.IEnvironment> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Environment]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
listEnvironmentsStream(request, options)
listEnvironmentsStream(request?: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options?: CallOptions): Transform;Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.
| Name | Description |
| request |
protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest
The request object that will be sent. |
| options |
CallOptions
Call options. See CallOptions for more details. |
| Type | Description |
| Transform | {Stream} An object stream which emits an object representing [Environment] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the context from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the context. |
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;Parse the context from ProjectAgentSessionContext resource.
| Name | Description |
| projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the context. |
matchEntityTypeFromEntityTypeName(entityTypeName)
matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;Parse the entity_type from EntityType resource.
| Name | Description |
| entityTypeName |
string
A fully-qualified path representing EntityType resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;Parse the entity_type from ProjectAgentSessionEntityType resource.
| Name | Description |
| projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the entity_type. |
matchEnvironmentFromEnvironmentName(environmentName)
matchEnvironmentFromEnvironmentName(environmentName: string): string | number;Parse the environment from Environment resource.
| Name | Description |
| environmentName |
string
A fully-qualified path representing Environment resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the environment. |
matchIntentFromIntentName(intentName)
matchIntentFromIntentName(intentName: string): string | number;Parse the intent from Intent resource.
| Name | Description |
| intentName |
string
A fully-qualified path representing Intent resource. |
| Type | Description |
| string | number | {string} A string representing the intent. |
matchProjectFromAgentName(agentName)
matchProjectFromAgentName(agentName: string): string | number;Parse the project from Agent resource.
| Name | Description |
| agentName |
string
A fully-qualified path representing Agent resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromEntityTypeName(entityTypeName)
matchProjectFromEntityTypeName(entityTypeName: string): string | number;Parse the project from EntityType resource.
| Name | Description |
| entityTypeName |
string
A fully-qualified path representing EntityType resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromEnvironmentName(environmentName)
matchProjectFromEnvironmentName(environmentName: string): string | number;Parse the project from Environment resource.
| Name | Description |
| environmentName |
string
A fully-qualified path representing Environment resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromIntentName(intentName)
matchProjectFromIntentName(intentName: string): string | number;Parse the project from Intent resource.
| Name | Description |
| intentName |
string
A fully-qualified path representing Intent resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the project from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;Parse the project from ProjectAgentSessionContext resource.
| Name | Description |
| projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;Parse the project from ProjectAgentSessionEntityType resource.
| Name | Description |
| projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;Parse the project from Project resource.
| Name | Description |
| projectName |
string
A fully-qualified path representing Project resource. |
| Type | Description |
| string | number | {string} A string representing the project. |
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the session from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;Parse the session from ProjectAgentSessionContext resource.
| Name | Description |
| projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;Parse the session from ProjectAgentSessionEntityType resource.
| Name | Description |
| projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the session. |
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;Parse the user from ProjectAgentEnvironmentUserSessionContext resource.
| Name | Description |
| projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
| Type | Description |
| string | number | {string} A string representing the user. |
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.
| Name | Description |
| projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
| Type | Description |
| string | number | {string} A string representing the user. |
projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context)
projectAgentEnvironmentUserSessionContextPath(project: string, environment: string, user: string, session: string, context: string): string;Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.
| Name | Description |
| project |
string
|
| environment |
string
|
| user |
string
|
| session |
string
|
| context |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entityType)
projectAgentEnvironmentUserSessionEntityTypePath(project: string, environment: string, user: string, session: string, entityType: string): string;Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.
| Name | Description |
| project |
string
|
| environment |
string
|
| user |
string
|
| session |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentSessionContextPath(project, session, context)
projectAgentSessionContextPath(project: string, session: string, context: string): string;Return a fully-qualified projectAgentSessionContext resource name string.
| Name | Description |
| project |
string
|
| session |
string
|
| context |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectAgentSessionEntityTypePath(project, session, entityType)
projectAgentSessionEntityTypePath(project: string, session: string, entityType: string): string;Return a fully-qualified projectAgentSessionEntityType resource name string.
| Name | Description |
| project |
string
|
| session |
string
|
| entityType |
string
|
| Type | Description |
| string | {string} Resource name string. |
projectPath(project)
projectPath(project: string): string;Return a fully-qualified project resource name string.
| Name | Description |
| project |
string
|
| Type | Description |
| string | {string} Resource name string. |