@google-cloud/dialogflow
Version:
Dialogflow API client for Node.js
823 lines • 109 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Service for managing
* {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfiles}.
* @class
* @memberof v2beta1
*/
export declare class ConversationProfilesClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
locationsClient: LocationsClient;
pathTemplates: {
[name: string]: gax.PathTemplate;
};
operationsClient: gax.OperationsClient;
conversationProfilesStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of ConversationProfilesClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new ConversationProfilesClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* 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 {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Retrieves the specified conversation profile.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The resource name of the conversation profile.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversationProfiles/<Conversation Profile ID>`.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.get_conversation_profile.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_GetConversationProfile_async
*/
getConversationProfile(request?: protos.google.cloud.dialogflow.v2beta1.IGetConversationProfileRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2beta1.IConversationProfile,
protos.google.cloud.dialogflow.v2beta1.IGetConversationProfileRequest | undefined,
{} | undefined
]>;
getConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.IGetConversationProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.IGetConversationProfileRequest | null | undefined, {} | null | undefined>): void;
getConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.IGetConversationProfileRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.IGetConversationProfileRequest | null | undefined, {} | null | undefined>): void;
/**
* Creates a conversation profile in the specified project.
*
* {@link protos.|ConversationProfile.CreateTime} and {@link protos.|ConversationProfile.UpdateTime}
* aren't populated in the response. You can retrieve them via
* {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile|GetConversationProfile}
* API.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The project to create a conversation profile for.
* Format: `projects/<Project ID>/locations/<Location ID>`.
* @param {google.cloud.dialogflow.v2beta1.ConversationProfile} request.conversationProfile
* Required. The conversation profile to create.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.create_conversation_profile.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_CreateConversationProfile_async
*/
createConversationProfile(request?: protos.google.cloud.dialogflow.v2beta1.ICreateConversationProfileRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2beta1.IConversationProfile,
protos.google.cloud.dialogflow.v2beta1.ICreateConversationProfileRequest | undefined,
{} | undefined
]>;
createConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.ICreateConversationProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.ICreateConversationProfileRequest | null | undefined, {} | null | undefined>): void;
createConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.ICreateConversationProfileRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.ICreateConversationProfileRequest | null | undefined, {} | null | undefined>): void;
/**
* Updates the specified conversation profile.
*
* {@link protos.|ConversationProfile.CreateTime} and {@link protos.|ConversationProfile.UpdateTime}
* aren't populated in the response. You can retrieve them via
* {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfiles.GetConversationProfile|GetConversationProfile}
* API.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.cloud.dialogflow.v2beta1.ConversationProfile} request.conversationProfile
* Required. The conversation profile to update.
* @param {google.protobuf.FieldMask} request.updateMask
* Required. The mask to control which fields to update.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.update_conversation_profile.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_UpdateConversationProfile_async
*/
updateConversationProfile(request?: protos.google.cloud.dialogflow.v2beta1.IUpdateConversationProfileRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2beta1.IConversationProfile,
protos.google.cloud.dialogflow.v2beta1.IUpdateConversationProfileRequest | undefined,
{} | undefined
]>;
updateConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.IUpdateConversationProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.IUpdateConversationProfileRequest | null | undefined, {} | null | undefined>): void;
updateConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.IUpdateConversationProfileRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.IUpdateConversationProfileRequest | null | undefined, {} | null | undefined>): void;
/**
* Deletes the specified conversation profile.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the conversation profile to delete.
* Format: `projects/<Project ID>/locations/<Location
* ID>/conversationProfiles/<Conversation Profile ID>`.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.delete_conversation_profile.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_DeleteConversationProfile_async
*/
deleteConversationProfile(request?: protos.google.cloud.dialogflow.v2beta1.IDeleteConversationProfileRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.cloud.dialogflow.v2beta1.IDeleteConversationProfileRequest | undefined,
{} | undefined
]>;
deleteConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.IDeleteConversationProfileRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteConversationProfileRequest | null | undefined, {} | null | undefined>): void;
deleteConversationProfile(request: protos.google.cloud.dialogflow.v2beta1.IDeleteConversationProfileRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteConversationProfileRequest | null | undefined, {} | null | undefined>): void;
/**
* Adds or updates a suggestion feature in a conversation profile.
* If the conversation profile contains the type of suggestion feature for
* the participant role, it will update it. Otherwise it will insert the
* suggestion feature.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
* The returned `Operation` type has the following method-specific fields:
*
* - `metadata`:
* {@link protos.google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata|SetSuggestionFeatureConfigOperationMetadata}
* - `response`:
* {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile}
*
* If a long running operation to add or update suggestion feature
* config for the same conversation profile, participant role and suggestion
* feature type exists, please cancel the existing long running operation
* before sending such request, otherwise the request will be rejected.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.conversationProfile
* Required. The Conversation Profile to add or update the suggestion feature
* config. Format: `projects/<Project ID>/locations/<Location
* ID>/conversationProfiles/<Conversation Profile ID>`.
* @param {google.cloud.dialogflow.v2beta1.Participant.Role} request.participantRole
* Required. The participant role to add or update the suggestion feature
* config. Only HUMAN_AGENT or END_USER can be used.
* @param {google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionFeatureConfig} request.suggestionFeatureConfig
* Required. The suggestion feature config to add or update.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.set_suggestion_feature_config.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_SetSuggestionFeatureConfig_async
*/
setSuggestionFeatureConfig(request?: protos.google.cloud.dialogflow.v2beta1.ISetSuggestionFeatureConfigRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.ISetSuggestionFeatureConfigOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
setSuggestionFeatureConfig(request: protos.google.cloud.dialogflow.v2beta1.ISetSuggestionFeatureConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.ISetSuggestionFeatureConfigOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
setSuggestionFeatureConfig(request: protos.google.cloud.dialogflow.v2beta1.ISetSuggestionFeatureConfigRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.ISetSuggestionFeatureConfigOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `setSuggestionFeatureConfig()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.set_suggestion_feature_config.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_SetSuggestionFeatureConfig_async
*/
checkSetSuggestionFeatureConfigProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2beta1.ConversationProfile, protos.google.cloud.dialogflow.v2beta1.SetSuggestionFeatureConfigOperationMetadata>>;
/**
* Clears a suggestion feature from a conversation profile for the given
* participant role.
*
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
* The returned `Operation` type has the following method-specific fields:
*
* - `metadata`:
* {@link protos.google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata|ClearSuggestionFeatureConfigOperationMetadata}
* - `response`:
* {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile}
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.conversationProfile
* Required. The Conversation Profile to add or update the suggestion feature
* config. Format: `projects/<Project ID>/locations/<Location
* ID>/conversationProfiles/<Conversation Profile ID>`.
* @param {google.cloud.dialogflow.v2beta1.Participant.Role} request.participantRole
* Required. The participant role to remove the suggestion feature
* config. Only HUMAN_AGENT or END_USER can be used.
* @param {google.cloud.dialogflow.v2beta1.SuggestionFeature.Type} request.suggestionFeatureType
* Required. The type of the suggestion feature to remove.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.clear_suggestion_feature_config.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_ClearSuggestionFeatureConfig_async
*/
clearSuggestionFeatureConfig(request?: protos.google.cloud.dialogflow.v2beta1.IClearSuggestionFeatureConfigRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.IClearSuggestionFeatureConfigOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
clearSuggestionFeatureConfig(request: protos.google.cloud.dialogflow.v2beta1.IClearSuggestionFeatureConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.IClearSuggestionFeatureConfigOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
clearSuggestionFeatureConfig(request: protos.google.cloud.dialogflow.v2beta1.IClearSuggestionFeatureConfigRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IConversationProfile, protos.google.cloud.dialogflow.v2beta1.IClearSuggestionFeatureConfigOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `clearSuggestionFeatureConfig()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.clear_suggestion_feature_config.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_ClearSuggestionFeatureConfig_async
*/
checkClearSuggestionFeatureConfigProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2beta1.ConversationProfile, protos.google.cloud.dialogflow.v2beta1.ClearSuggestionFeatureConfigOperationMetadata>>;
/**
* Returns the list of all conversation profiles in the specified project.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The project to list all conversation profiles from.
* Format: `projects/<Project ID>/locations/<Location ID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By
* default 100 and at most 1000.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is Array of {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile}.
* 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 `listConversationProfilesAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listConversationProfiles(request?: protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2beta1.IConversationProfile[],
protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest | null,
protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesResponse
]>;
listConversationProfiles(request: protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest, protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IConversationProfile>): void;
listConversationProfiles(request: protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest, protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IConversationProfile>): void;
/**
* Equivalent to `listConversationProfiles`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The project to list all conversation profiles from.
* Format: `projects/<Project ID>/locations/<Location ID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By
* default 100 and at most 1000.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile} 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 `listConversationProfilesAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listConversationProfilesStream(request?: protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest, options?: CallOptions): Transform;
/**
* Equivalent to `listConversationProfiles`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The project to list all conversation profiles from.
* Format: `projects/<Project ID>/locations/<Location ID>`.
* @param {number} request.pageSize
* The maximum number of items to return in a single page. By
* default 100 and at most 1000.
* @param {string} request.pageToken
* The next_page_token value returned from a previous list request.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.dialogflow.v2beta1.ConversationProfile|ConversationProfile}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2beta1/conversation_profiles.list_conversation_profiles.js</caption>
* region_tag:dialogflow_v2beta1_generated_ConversationProfiles_ListConversationProfiles_async
*/
listConversationProfilesAsync(request?: protos.google.cloud.dialogflow.v2beta1.IListConversationProfilesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2beta1.IConversationProfile>;
/**
* Gets information about a location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Resource name for the location.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example
* ```
* const [response] = await client.getLocation(request);
* ```
*/
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
/**
* Lists information about the supported locations for this service. Returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* The resource that owns the locations collection, if applicable.
* @param {string} request.filter
* The standard list filter.
* @param {number} request.pageSize
* The standard list page size.
* @param {string} request.pageToken
* The standard list page token.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link google.cloud.location.Location | Location}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example
* ```
* const iterable = client.listLocationsAsync(request);
* for await (const response of iterable) {
* // process response
* }
* ```
*/
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
/**
* Gets the latest state of a long-running operation. Clients can use this
* method to poll the operation result at intervals as recommended by the API
* service.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* const name = '';
* const [response] = await client.getOperation({name});
* // doThingsWith(response)
* ```
*/
getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
/**
* Lists operations that match the specified filter in the request. If the
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
*
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation collection.
* @param {string} request.filter - The standard list filter.
* @param {number=} request.pageSize -
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*
* @example
* ```
* const client = longrunning.operationsClient();
* for await (const response of client.listOperationsAsync(request));
* // doThingsWith(response)
* ```
*/
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
/**
* Starts asynchronous cancellation on a long-running operation. The server
* makes a best effort to cancel the operation, but success is not
* guaranteed. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
* {@link Operations.GetOperation} or
* other methods to check whether the cancellation succeeded or whether the
* operation completed despite cancellation. On successful cancellation,
* the operation is not deleted; instead, it becomes an operation with
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
* 1, corresponding to `Code.CANCELLED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be cancelled.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.cancelOperation({name: ''});
* ```
*/
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
/**
* Deletes a long-running operation. This method indicates that the client is
* no longer interested in the operation result. It does not cancel the
* operation. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be deleted.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.deleteOperation({name: ''});
* ```
*/
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
/**
* Return a fully-qualified cXSecuritySettings resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} security_settings
* @returns {string} Resource name string.
*/
cXSecuritySettingsPath(project: string, location: string, securitySettings: string): string;
/**
* Parse the project from CXSecuritySettings resource.
*
* @param {string} cXSecuritySettingsName
* A fully-qualified path representing CXSecuritySettings resource.
* @returns {string} A string representing the project.
*/
matchProjectFromCXSecuritySettingsName(cXSecuritySettingsName: string): string | number;
/**
* Parse the location from CXSecuritySettings resource.
*
* @param {string} cXSecuritySettingsName
* A fully-qualified path representing CXSecuritySettings resource.
* @returns {string} A string representing the location.
*/
matchLocationFromCXSecuritySettingsName(cXSecuritySettingsName: string): string | number;
/**
* Parse the security_settings from CXSecuritySettings resource.
*
* @param {string} cXSecuritySettingsName
* A fully-qualified path representing CXSecuritySettings resource.
* @returns {string} A string representing the security_settings.
*/
matchSecuritySettingsFromCXSecuritySettingsName(cXSecuritySettingsName: string): string | number;
/**
* Return a fully-qualified encryptionSpec resource name string.
*
* @param {string} project
* @param {string} location
* @returns {string} Resource name string.
*/
encryptionSpecPath(project: string, location: string): string;
/**
* Parse the project from EncryptionSpec resource.
*
* @param {string} encryptionSpecName
* A fully-qualified path representing EncryptionSpec resource.
* @returns {string} A string representing the project.
*/
matchProjectFromEncryptionSpecName(encryptionSpecName: string): string | number;
/**
* Parse the location from EncryptionSpec resource.
*
* @param {string} encryptionSpecName
* A fully-qualified path representing EncryptionSpec resource.
* @returns {string} A string representing the location.
*/
matchLocationFromEncryptionSpecName(encryptionSpecName: string): string | number;
/**
* Return a fully-qualified generator resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} generator
* @returns {string} Resource name string.
*/
generatorPath(project: string, location: string, generator: string): string;
/**
* Parse the project from Generator resource.
*
* @param {string} generatorName
* A fully-qualified path representing Generator resource.
* @returns {string} A string representing the project.
*/
matchProjectFromGeneratorName(generatorName: string): string | number;
/**
* Parse the location from Generator resource.
*
* @param {string} generatorName
* A fully-qualified path representing Generator resource.
* @returns {string} A string representing the location.
*/
matchLocationFromGeneratorName(generatorName: string): string | number;
/**
* Parse the generator from Generator resource.
*
* @param {string} generatorName
* A fully-qualified path representing Generator resource.
* @returns {string} A string representing the generator.
*/
matchGeneratorFromGeneratorName(generatorName: string): string | number;
/**
* Return a fully-qualified generatorEvaluation resource name string.
*
* @param {string} project
* @param {string} location
* @param {string} generator
* @param {string} evaluation
* @returns {string} Resource name string.
*/
generatorEvaluationPath(project: string, location: string, generator: string, evaluation: string): string;
/**
* Parse the project from GeneratorEvaluation resource.
*
* @param {string} generatorEvaluationName
* A fully-qualified path representing GeneratorEvaluation resource.
* @returns {string} A string representing the project.
*/
matchProjectFromGeneratorEvaluationName(generatorEvaluationName: string): string | number;
/**
* Parse the location from GeneratorEvaluation resource.
*
* @param {string} generatorEvaluationName
* A fully-qualified path representing GeneratorEvaluation resource.
* @returns {string} A string representing the location.
*/
matchLocationFromGeneratorEvaluationName(generatorEvaluationName: string): string | number;
/**
* Parse the generator from GeneratorEvaluation resource.
*
* @param {string} generatorEvaluationName
* A fully-qualified path representing GeneratorEvaluation resource.
* @returns {string} A string representing the generator.
*/
matchGeneratorFromGeneratorEvaluationName(generatorEvaluationName: string): string | number;
/**
* Parse the evaluation from GeneratorEvaluation resource.
*
* @param {string} generatorEvaluationName
* A fully-qualified path representing GeneratorEvaluation resource.
* @returns {string} A string representing the evaluation.
*/
matchEvaluationFromGeneratorEvaluationName(generatorEvaluationName: string): string | number;
/**
* Return a fully-qualified project resource name string.
*
* @param {string} project
* @returns {string} Resource name string.
*/
projectPath(project: string): string;
/**
* Parse the project from Project resource.
*
* @param {string} projectName
* A fully-qualified path representing Project resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectName(projectName: string): string | number;
/**
* Return a fully-qualified projectAgent resource name string.
*
* @param {string} project
* @returns {string} Resource name string.
*/
projectAgentPath(project: string): string;
/**
* Parse the project from ProjectAgent resource.
*
* @param {string} projectAgentName
* A fully-qualified path representing project_agent resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentName(projectAgentName: string): string | number;
/**
* Return a fully-qualified projectAgentEntityType resource name string.
*
* @param {string} project
* @param {string} entity_type
* @returns {string} Resource name string.
*/
projectAgentEntityTypePath(project: string, entityType: string): string;
/**
* Parse the project from ProjectAgentEntityType resource.
*
* @param {string} projectAgentEntityTypeName
* A fully-qualified path representing project_agent_entity_type resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;
/**
* Parse the entity_type from ProjectAgentEntityType resource.
*
* @param {string} projectAgentEntityTypeName
* A fully-qualified path representing project_agent_entity_type resource.
* @returns {string} A string representing the entity_type.
*/
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;
/**
* Return a fully-qualified projectAgentEnvironment resource name string.
*
* @param {string} project
* @param {string} environment
* @returns {string} Resource name string.
*/
projectAgentEnvironmentPath(project: string, environment: string): string;
/**
* Parse the project from ProjectAgentEnvironment resource.
*
* @param {string} projectAgentEnvironmentName
* A fully-qualified path representing project_agent_environment resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;
/**
* Parse the environment from ProjectAgentEnvironment resource.
*
* @param {string} projectAgentEnvironmentName
* A fully-qualified path representing project_agent_environment resource.
* @returns {string} A string representing the environment.
*/
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;
/**
* Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.
*
* @param {string} project
* @param {string} environment
* @param {string} user
* @param {string} session
* @param {string} context
* @returns {string} Resource name string.
*/
projectAgentEnvironmentUserSessionContextPath(project: string, environment: string, user: string, session: string, context: string): string;
/**
* Parse the project from