Class v3beta1.AgentsClient

Service for managing . v3beta1

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AgentsClient.

Parameter
NameDescription
opts ClientOptions

Properties

agentsStub

agentsStub?: Promise<{
        [name: string]: Function;
    }>;

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

agentPath(project, location, agent)

agentPath(project: string, location: string, agent: string): string;

Return a fully-qualified agent resource name string.

Parameters
NameDescription
project string
location string
agent string
Returns
TypeDescription
string

{string} Resource name string.

agentValidationResultPath(project, location, agent)

agentValidationResultPath(project: string, location: string, agent: string): string;

Return a fully-qualified agentValidationResult resource name string.

Parameters
NameDescription
project string
location string
agent string
Returns
TypeDescription
string

{string} Resource name string.

changelogPath(project, location, agent, changelog)

changelogPath(project: string, location: string, agent: string, changelog: string): string;

Return a fully-qualified changelog resource name string.

Parameters
NameDescription
project string
location string
agent string
changelog string
Returns
TypeDescription
string

{string} Resource name string.

checkExportAgentProgress(name)

checkExportAgentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse, protos.google.protobuf.Struct>>;

Check the status of the long running operation returned by exportAgent().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse, protos.google.protobuf.Struct>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to export.
   *  Format: `projects/

checkRestoreAgentProgress(name)

checkRestoreAgentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;

Check the status of the long running operation returned by restoreAgent().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to restore into.
   *  Format: `projects/

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.

Returns
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

continuousTestResultPath(project, location, agent, environment, continuousTestResult)

continuousTestResultPath(project: string, location: string, agent: string, environment: string, continuousTestResult: string): string;

Return a fully-qualified continuousTestResult resource name string.

Parameters
NameDescription
project string
location string
agent string
environment string
continuousTestResult string
Returns
TypeDescription
string

{string} Resource name string.

createAgent(request, options)

createAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | undefined, {} | undefined]>;

Creates an agent in the specified location.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Agent]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to create a agent for.
   *  Format: `projects/

createAgent(request, options, callback)

createAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createAgent(request, callback)

createAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.ICreateAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAgent(request, options)

deleteAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | undefined, {} | undefined]>;

Deletes the specified agent.

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to delete.
   *  Format: `projects/

deleteAgent(request, options, callback)

deleteAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAgent(request, callback)

deleteAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deploymentPath(project, location, agent, environment, deployment)

deploymentPath(project: string, location: string, agent: string, environment: string, deployment: string): string;

Return a fully-qualified deployment resource name string.

Parameters
NameDescription
project string
location string
agent string
environment string
deployment string
Returns
TypeDescription
string

{string} Resource name string.

entityTypePath(project, location, agent, entityType)

entityTypePath(project: string, location: string, agent: string, entityType: string): string;

Return a fully-qualified entityType resource name string.

Parameters
NameDescription
project string
location string
agent string
entityType string
Returns
TypeDescription
string

{string} Resource name string.

environmentPath(project, location, agent, environment)

environmentPath(project: string, location: string, agent: string, environment: string): string;

Return a fully-qualified environment resource name string.

Parameters
NameDescription
project string
location string
agent string
environment string
Returns
TypeDescription
string

{string} Resource name string.

experimentPath(project, location, agent, environment, experiment)

experimentPath(project: string, location: string, agent: string, environment: string, experiment: string): string;

Return a fully-qualified experiment resource name string.

Parameters
NameDescription
project string
location string
agent string
environment string
experiment string
Returns
TypeDescription
string

{string} Resource name string.

exportAgent(request, options)

exportAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Exports the specified agent to a binary file.

This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned Operation type has the following method-specific fields:

  • metadata: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - response:
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent to export.
   *  Format: `projects/

exportAgent(request, options, callback)

exportAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

exportAgent(request, callback)

exportAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentRequest
callback Callback<LROperation<protos.google.cloud.dialogflow.cx.v3beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

flowPath(project, location, agent, flow)

flowPath(project: string, location: string, agent: string, flow: string): string;

Return a fully-qualified flow resource name string.

Parameters
NameDescription
project string
location string
agent string
flow string
Returns
TypeDescription
string

{string} Resource name string.

flowValidationResultPath(project, location, agent, flow)

flowValidationResultPath(project: string, location: string, agent: string, flow: string): string;

Return a fully-qualified flowValidationResult resource name string.

Parameters
NameDescription
project string
location string
agent string
flow string
Returns
TypeDescription
string

{string} Resource name string.

getAgent(request, options)

getAgent(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | undefined, {} | undefined]>;

Retrieves the specified agent.

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Agent]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the agent.
   *  Format: `projects/

getAgent(request, options, callback)

getAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAgent(request, callback)

getAgent(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgent, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAgentValidationResult(request, options)

getAgentValidationResult(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, (protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | undefined), {} | undefined]>;

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, (protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | undefined), {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [AgentValidationResult]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The agent name.
   *  Format: `projects/

getAgentValidationResult(request, options, callback)

getAgentValidationResult(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAgentValidationResult(request, callback)

getAgentValidationResult(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest
callback Callback<protos.google.cloud.dialogflow.cx.v3beta1.IAgentValidationResult, protos.google.cloud.dialogflow.cx.v3beta1.IGetAgentValidationResultRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

intentPath(project, location, agent, intent)

intentPath(project: string, location: string, agent: string, intent: string): string;

Return a fully-qualified intent resource name string.

Parameters
NameDescription
project string
location string
agent string
intent string
Returns
TypeDescription
string

{string} Resource name string.

listAgents(request, options)

listAgents(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent[], protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse]>;

Returns the list of all agents in the specified location.

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.IAgent[], protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Agent]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAgentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listAgents(request, options, callback)

listAgents(request: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>
Returns
TypeDescription
void

listAgents(request, callback)

listAgents(request: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest
callback PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.IAgent>
Returns
TypeDescription
void

listAgentsAsync(request, options)

listAgentsAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IAgent>;

Equivalent to listAgents, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.IAgent>

{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 [Agent]. 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.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to list all agents for.
   *  Format: `projects/

listAgentsStream(request, options)

listAgentsStream(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.dialogflow.cx.v3beta1.IListAgentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Agent] 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 listAgentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchAgentFromAgentName(agentName)

matchAgentFromAgentName(agentName: string): string | number;

Parse the agent from Agent resource.

Parameter
NameDescription
agentName string

A fully-qualified path representing Agent resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromAgentValidationResultName(agentValidationResultName)

matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the agent from AgentValidationResult resource.

Parameter
NameDescription
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromChangelogName(changelogName)

matchAgentFromChangelogName(changelogName: string): string | number;

Parse the agent from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromContinuousTestResultName(continuousTestResultName)

matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the agent from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromDeploymentName(deploymentName)

matchAgentFromDeploymentName(deploymentName: string): string | number;

Parse the agent from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromEntityTypeName(entityTypeName)

matchAgentFromEntityTypeName(entityTypeName: string): string | number;

Parse the agent from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromEnvironmentName(environmentName)

matchAgentFromEnvironmentName(environmentName: string): string | number;

Parse the agent from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromExperimentName(experimentName)

matchAgentFromExperimentName(experimentName: string): string | number;

Parse the agent from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromFlowName(flowName)

matchAgentFromFlowName(flowName: string): string | number;

Parse the agent from Flow resource.

Parameter
NameDescription
flowName string

A fully-qualified path representing Flow resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromFlowValidationResultName(flowValidationResultName)

matchAgentFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the agent from FlowValidationResult resource.

Parameter
NameDescription
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromIntentName(intentName)

matchAgentFromIntentName(intentName: string): string | number;

Parse the agent from Intent resource.

Parameter
NameDescription
intentName string

A fully-qualified path representing Intent resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromPageName(pageName)

matchAgentFromPageName(pageName: string): string | number;

Parse the agent from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromTestCaseName(testCaseName)

matchAgentFromTestCaseName(testCaseName: string): string | number;

Parse the agent from TestCase resource.

Parameter
NameDescription
testCaseName string

A fully-qualified path representing TestCase resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromTestCaseResultName(testCaseResultName)

matchAgentFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the agent from TestCaseResult resource.

Parameter
NameDescription
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName)

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the agent from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromVersionName(versionName)

matchAgentFromVersionName(versionName: string): string | number;

Parse the agent from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchAgentFromWebhookName(webhookName)

matchAgentFromWebhookName(webhookName: string): string | number;

Parse the agent from Webhook resource.

Parameter
NameDescription
webhookName string

A fully-qualified path representing Webhook resource.

Returns
TypeDescription
string | number

{string} A string representing the agent.

matchChangelogFromChangelogName(changelogName)

matchChangelogFromChangelogName(changelogName: string): string | number;

Parse the changelog from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the changelog.

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName)

matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the continuous_test_result from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the continuous_test_result.

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the deployment.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEnvironmentFromContinuousTestResultName(continuousTestResultName)

matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the environment from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromDeploymentName(deploymentName)

matchEnvironmentFromDeploymentName(deploymentName: string): string | number;

Parse the environment from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromExperimentName(experimentName)

matchEnvironmentFromExperimentName(experimentName: string): string | number;

Parse the environment from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchExperimentFromExperimentName(experimentName)

matchExperimentFromExperimentName(experimentName: string): string | number;

Parse the experiment from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the experiment.

matchFlowFromFlowName(flowName)

matchFlowFromFlowName(flowName: string): string | number;

Parse the flow from Flow resource.

Parameter
NameDescription
flowName string

A fully-qualified path representing Flow resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromFlowValidationResultName(flowValidationResultName)

matchFlowFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the flow from FlowValidationResult resource.

Parameter
NameDescription
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromPageName(pageName)

matchFlowFromPageName(pageName: string): string | number;

Parse the flow from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName)

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the flow from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchFlowFromVersionName(versionName)

matchFlowFromVersionName(versionName: string): string | number;

Parse the flow from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the flow.

matchIntentFromIntentName(intentName)

matchIntentFromIntentName(intentName: string): string | number;

Parse the intent from Intent resource.

Parameter
NameDescription
intentName string

A fully-qualified path representing Intent resource.

Returns
TypeDescription
string | number

{string} A string representing the intent.

matchLocationFromAgentName(agentName)

matchLocationFromAgentName(agentName: string): string | number;

Parse the location from Agent resource.

Parameter
NameDescription
agentName string

A fully-qualified path representing Agent resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromAgentValidationResultName(agentValidationResultName)

matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the location from AgentValidationResult resource.

Parameter
NameDescription
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromChangelogName(changelogName)

matchLocationFromChangelogName(changelogName: string): string | number;

Parse the location from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromContinuousTestResultName(continuousTestResultName)

matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the location from ContinuousTestResult resource.

Parameter
NameDescription
continuousTestResultName string

A fully-qualified path representing ContinuousTestResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter
NameDescription
deploymentName string

A fully-qualified path representing Deployment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter
NameDescription
entityTypeName string

A fully-qualified path representing EntityType resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

Parameter
NameDescription
environmentName string

A fully-qualified path representing Environment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromExperimentName(experimentName)

matchLocationFromExperimentName(experimentName: string): string | number;

Parse the location from Experiment resource.

Parameter
NameDescription
experimentName string

A fully-qualified path representing Experiment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFlowName(flowName)

matchLocationFromFlowName(flowName: string): string | number;

Parse the location from Flow resource.

Parameter
NameDescription
flowName string

A fully-qualified path representing Flow resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromFlowValidationResultName(flowValidationResultName)

matchLocationFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the location from FlowValidationResult resource.

Parameter
NameDescription
flowValidationResultName string

A fully-qualified path representing FlowValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromIntentName(intentName)

matchLocationFromIntentName(intentName: string): string | number;

Parse the location from Intent resource.

Parameter
NameDescription
intentName string

A fully-qualified path representing Intent resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromPageName(pageName)

matchLocationFromPageName(pageName: string): string | number;

Parse the location from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentEnvironmentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSecuritySettingsName(securitySettingsName)

matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the location from SecuritySettings resource.

Parameter
NameDescription
securitySettingsName string

A fully-qualified path representing SecuritySettings resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTestCaseName(testCaseName)

matchLocationFromTestCaseName(testCaseName: string): string | number;

Parse the location from TestCase resource.

Parameter
NameDescription
testCaseName string

A fully-qualified path representing TestCase resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTestCaseResultName(testCaseResultName)

matchLocationFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the location from TestCaseResult resource.

Parameter
NameDescription
testCaseResultName string

A fully-qualified path representing TestCaseResult resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName)

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the location from TransitionRouteGroup resource.

Parameter
NameDescription
transitionRouteGroupName string

A fully-qualified path representing TransitionRouteGroup resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromVersionName(versionName)

matchLocationFromVersionName(versionName: string): string | number;

Parse the location from Version resource.

Parameter
NameDescription
versionName string

A fully-qualified path representing Version resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromWebhookName(webhookName)

matchLocationFromWebhookName(webhookName: string): string | number;

Parse the location from Webhook resource.

Parameter
NameDescription
webhookName string

A fully-qualified path representing Webhook resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchPageFromPageName(pageName)

matchPageFromPageName(pageName: string): string | number;

Parse the page from Page resource.

Parameter
NameDescription
pageName string

A fully-qualified path representing Page resource.

Returns
TypeDescription
string | number

{string} A string representing the page.

matchProjectFromAgentName(agentName)

matchProjectFromAgentName(agentName: string): string | number;

Parse the project from Agent resource.

Parameter
NameDescription
agentName string

A fully-qualified path representing Agent resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromAgentValidationResultName(agentValidationResultName)

matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the project from AgentValidationResult resource.

Parameter
NameDescription
agentValidationResultName string

A fully-qualified path representing AgentValidationResult resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromChangelogName(changelogName)

matchProjectFromChangelogName(changelogName: string): string | number;

Parse the project from Changelog resource.

Parameter
NameDescription
changelogName string

A fully-qualified path representing Changelog resource.

Returns
TypeDescription
string | number

{string} A string representing the project.