import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Service to ask a natural language question on top of BigQuery * and Looker Studio datasources to get back streamed responses of various kinds * to help provide a rich conversational answer. * @class * @memberof v1alpha */ export declare class DataChatServiceClient { 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; }; dataChatServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of DataChatServiceClient. * * @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 DataChatServiceClient({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; getProjectId(callback: Callback): void; /** * Creates a new conversation to persist the conversation history. Each * conversation will have multiple messages associated with it. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent value for CreateConversationRequest. * Format: `projects/{project}/locations/{location}` * @param {string} [request.conversationId] * Optional. The conversation id of the conversation to create. * Must be unique within the parent. * The allowed format is: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. * If not provided, the server will auto-generate a value for the id. * @param {google.cloud.geminidataanalytics.v1alpha.Conversation} request.conversation * Required. The conversation to create. * @param {string} [request.requestId] * Optional. An optional request ID to identify requests. Specify a unique * request ID so that if you must retry your request, the server will know to * ignore the request if it has already been completed. The server will * guarantee that for at least 60 minutes since the first 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 an object representing {@link protos.google.cloud.geminidataanalytics.v1alpha.Conversation|Conversation}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/data_chat_service.create_conversation.js * region_tag:geminidataanalytics_v1alpha_generated_DataChatService_CreateConversation_async */ createConversation(request?: protos.google.cloud.geminidataanalytics.v1alpha.ICreateConversationRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1alpha.IConversation, (protos.google.cloud.geminidataanalytics.v1alpha.ICreateConversationRequest | undefined), {} | undefined ]>; createConversation(request: protos.google.cloud.geminidataanalytics.v1alpha.ICreateConversationRequest, options: CallOptions, callback: Callback): void; createConversation(request: protos.google.cloud.geminidataanalytics.v1alpha.ICreateConversationRequest, callback: Callback): void; /** * Deletes a conversation. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the resource. * Format: * `projects/{project}/locations/{location}/conversations/{conversation}` * @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 include:samples/generated/v1alpha/data_chat_service.delete_conversation.js * region_tag:geminidataanalytics_v1alpha_generated_DataChatService_DeleteConversation_async */ deleteConversation(request?: protos.google.cloud.geminidataanalytics.v1alpha.IDeleteConversationRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.geminidataanalytics.v1alpha.IDeleteConversationRequest | undefined), {} | undefined ]>; deleteConversation(request: protos.google.cloud.geminidataanalytics.v1alpha.IDeleteConversationRequest, options: CallOptions, callback: Callback): void; deleteConversation(request: protos.google.cloud.geminidataanalytics.v1alpha.IDeleteConversationRequest, callback: Callback): void; /** * Gets details of a single conversation by using conversation id and parent. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the resource. * Format: * `projects/{project}/locations/{location}/conversations/{conversation}` * @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.geminidataanalytics.v1alpha.Conversation|Conversation}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/data_chat_service.get_conversation.js * region_tag:geminidataanalytics_v1alpha_generated_DataChatService_GetConversation_async */ getConversation(request?: protos.google.cloud.geminidataanalytics.v1alpha.IGetConversationRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1alpha.IConversation, (protos.google.cloud.geminidataanalytics.v1alpha.IGetConversationRequest | undefined), {} | undefined ]>; getConversation(request: protos.google.cloud.geminidataanalytics.v1alpha.IGetConversationRequest, options: CallOptions, callback: Callback): void; getConversation(request: protos.google.cloud.geminidataanalytics.v1alpha.IGetConversationRequest, callback: Callback): void; /** * Queries data from a natural language user query. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent resource to generate the query for. * Format: projects/{project}/locations/{location} * @param {string} request.prompt * Required. The natural language query for which to generate query. * Example: "What are the top 5 best selling products this month?" * @param {google.cloud.geminidataanalytics.v1alpha.QueryDataContext} request.context * Required. The context for the data query, including the data sources to * use. * @param {google.cloud.geminidataanalytics.v1alpha.GenerationOptions} [request.generationOptions] * Optional. Options to control query generation and execution behavior. * @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.geminidataanalytics.v1alpha.QueryDataResponse|QueryDataResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/data_chat_service.query_data.js * region_tag:geminidataanalytics_v1alpha_generated_DataChatService_QueryData_async */ queryData(request?: protos.google.cloud.geminidataanalytics.v1alpha.IQueryDataRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1alpha.IQueryDataResponse, (protos.google.cloud.geminidataanalytics.v1alpha.IQueryDataRequest | undefined), {} | undefined ]>; queryData(request: protos.google.cloud.geminidataanalytics.v1alpha.IQueryDataRequest, options: CallOptions, callback: Callback): void; queryData(request: protos.google.cloud.geminidataanalytics.v1alpha.IQueryDataRequest, callback: Callback): void; /** * Answers a data question by generating a stream of * {@link protos.google.cloud.geminidataanalytics.v1alpha.Message|Message} objects. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.geminidataanalytics.v1alpha.Context} [request.inlineContext] * Optional. Inline context for the chat request. Use this to chat * statelessly (without managed conversation persistence and without an * Agent) by passing all context inline. * @param {google.cloud.geminidataanalytics.v1alpha.ConversationReference} [request.conversationReference] * Optional. Reference to a persisted conversation and agent context. * Use this to chat with an Agent using managed conversation persistence. * @param {google.cloud.geminidataanalytics.v1alpha.DataAgentContext} [request.dataAgentContext] * Optional. Context for the chat request. Use this to chat with an Agent * statelessly, without managed conversation persistence. * @param {google.cloud.geminidataanalytics.v1alpha.ClientManagedResourceContext} [request.clientManagedResourceContext] * Optional. Context with client managed resources. * Some clients may not use GDA managed resources including * conversations and agents, instead they create and manage their own * conversations and agents resources. * @param {string} [request.project] * Optional. The Google Cloud project to be used for quota and billing. * @param {string} request.parent * Required. The parent value for chat request. * Pattern: `projects/{project}/locations/{location}` * @param {number[]} request.messages * Required. Content of current conversation. * @param {google.cloud.geminidataanalytics.v1alpha.ChatRequest.ThinkingMode} [request.thinkingMode] * Optional. The thinking mode to use for the agent loop. * Defaults to THINKING_MODE_UNSPECIFIED if not specified. * @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 {@link protos.google.cloud.geminidataanalytics.v1alpha.Message|Message} on 'data' event. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation } * for more details and examples. * @example include:samples/generated/v1alpha/data_chat_service.chat.js * region_tag:geminidataanalytics_v1alpha_generated_DataChatService_Chat_async */ chat(request?: protos.google.cloud.geminidataanalytics.v1alpha.IChatRequest, options?: CallOptions): gax.CancellableStream; /** * Lists all conversations for a given parent. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent value for ListConversationsRequest. * Format: `projects/{project}/locations/{location}` * @param {number} [request.pageSize] * Optional. Requested page size. Server may return fewer items than * requested. The max page size is 100. All larger page sizes will be coerced * to 100. If unspecified, server will pick 50 as an approperiate default. * @param {string} [request.pageToken] * Optional. A token identifying a page of results the server should return. * @param {string} [request.filter] * Optional. Returned conversations will match criteria specified within the * filter. ListConversations allows filtering by: * * agents * * labels * @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.geminidataanalytics.v1alpha.Conversation|Conversation}. * 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 `listConversationsAsync()` * 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. */ listConversations(request?: protos.google.cloud.geminidataanalytics.v1alpha.IListConversationsRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1alpha.IConversation[], protos.google.cloud.geminidataanalytics.v1alpha.IListConversationsRequest | null, protos.google.cloud.geminidataanalytics.v1alpha.IListConversationsResponse ]>; listConversations(request: protos.google.cloud.geminidataanalytics.v1alpha.IListConversationsRequest, options: CallOptions, callback: PaginationCallback): void; listConversations(request: protos.google.cloud.geminidataanalytics.v1alpha.IListConversationsRequest, callback: PaginationCallback): void; /** * Equivalent to `listConversations`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent value for ListConversationsRequest. * Format: `projects/{project}/locations/{location}` * @param {number} [request.pageSize] * Optional. Requested page size. Server may return fewer items than * requested. The max page size is 100. All larger page sizes will be coerced * to 100. If unspecified, server will pick 50 as an approperiate default. * @param {string} [request.pageToken] * Optional. A token identifying a page of results the server should return. * @param {string} [request.filter] * Optional. Returned conversations will match criteria specified within the * filter. ListConversations allows filtering by: * * agents * * labels * @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.geminidataanalytics.v1alpha.Conversation|Conversation} 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 `listConversationsAsync()` * 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. */ listConversationsStream(request?: protos.google.cloud.geminidataanalytics.v1alpha.IListConversationsRequest, options?: CallOptions): Transform; /** * Equivalent to `listConversations`, 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. Parent value for ListConversationsRequest. * Format: `projects/{project}/locations/{location}` * @param {number} [request.pageSize] * Optional. Requested page size. Server may return fewer items than * requested. The max page size is 100. All larger page sizes will be coerced * to 100. If unspecified, server will pick 50 as an approperiate default. * @param {string} [request.pageToken] * Optional. A token identifying a page of results the server should return. * @param {string} [request.filter] * Optional. Returned conversations will match criteria specified within the * filter. ListConversations allows filtering by: * * agents * * labels * @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.geminidataanalytics.v1alpha.Conversation|Conversation}. 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 include:samples/generated/v1alpha/data_chat_service.list_conversations.js * region_tag:geminidataanalytics_v1alpha_generated_DataChatService_ListConversations_async */ listConversationsAsync(request?: protos.google.cloud.geminidataanalytics.v1alpha.IListConversationsRequest, options?: CallOptions): AsyncIterable; /** * Lists all messages for a given conversation. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The conversation to list messages under. * Format: * `projects/{project}/locations/{location}/conversations/{conversation_id}` * @param {number} [request.pageSize] * Optional. Requested page size. Server may return fewer items than * requested. The max page size is 100. All larger page sizes will be coerced * to 100. If unspecified, server will pick 50 as an approperiate default. * @param {string} [request.pageToken] * Optional. A token identifying a page of results the server should return. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * * ListMessages allows filtering by: * * create_time (e.g., `createTime > "2025-01-28T06:51:56-08:00"`) * * update_time * @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.geminidataanalytics.v1alpha.StorageMessage|StorageMessage}. * 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 `listMessagesAsync()` * 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. */ listMessages(request?: protos.google.cloud.geminidataanalytics.v1alpha.IListMessagesRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1alpha.IStorageMessage[], protos.google.cloud.geminidataanalytics.v1alpha.IListMessagesRequest | null, protos.google.cloud.geminidataanalytics.v1alpha.IListMessagesResponse ]>; listMessages(request: protos.google.cloud.geminidataanalytics.v1alpha.IListMessagesRequest, options: CallOptions, callback: PaginationCallback): void; listMessages(request: protos.google.cloud.geminidataanalytics.v1alpha.IListMessagesRequest, callback: PaginationCallback): void; /** * Equivalent to `listMessages`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The conversation to list messages under. * Format: * `projects/{project}/locations/{location}/conversations/{conversation_id}` * @param {number} [request.pageSize] * Optional. Requested page size. Server may return fewer items than * requested. The max page size is 100. All larger page sizes will be coerced * to 100. If unspecified, server will pick 50 as an approperiate default. * @param {string} [request.pageToken] * Optional. A token identifying a page of results the server should return. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * * ListMessages allows filtering by: * * create_time (e.g., `createTime > "2025-01-28T06:51:56-08:00"`) * * update_time * @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.geminidataanalytics.v1alpha.StorageMessage|StorageMessage} 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 `listMessagesAsync()` * 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. */ listMessagesStream(request?: protos.google.cloud.geminidataanalytics.v1alpha.IListMessagesRequest, options?: CallOptions): Transform; /** * Equivalent to `listMessages`, 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 conversation to list messages under. * Format: * `projects/{project}/locations/{location}/conversations/{conversation_id}` * @param {number} [request.pageSize] * Optional. Requested page size. Server may return fewer items than * requested. The max page size is 100. All larger page sizes will be coerced * to 100. If unspecified, server will pick 50 as an approperiate default. * @param {string} [request.pageToken] * Optional. A token identifying a page of results the server should return. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * * ListMessages allows filtering by: * * create_time (e.g., `createTime > "2025-01-28T06:51:56-08:00"`) * * update_time * @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.geminidataanalytics.v1alpha.StorageMessage|StorageMessage}. 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 include:samples/generated/v1alpha/data_chat_service.list_messages.js * region_tag:geminidataanalytics_v1alpha_generated_DataChatService_ListMessages_async */ listMessagesAsync(request?: protos.google.cloud.geminidataanalytics.v1alpha.IListMessagesRequest, options?: CallOptions): AsyncIterable; /** * 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, callback?: Callback): Promise; /** * 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; /** * Return a fully-qualified conversation resource name string. * * @param {string} project * @param {string} location * @param {string} conversation * @returns {string} Resource name string. */ conversationPath(project: string, location: string, conversation: string): string; /** * Parse the project from Conversation resource. * * @param {string} conversationName * A fully-qualified path representing Conversation resource. * @returns {string} A string representing the project. */ matchProjectFromConversationName(conversationName: string): string | number; /** * Parse the location from Conversation resource. * * @param {string} conversationName * A fully-qualified path representing Conversation resource. * @returns {string} A string representing the location. */ matchLocationFromConversationName(conversationName: string): string | number; /** * Parse the conversation from Conversation resource. * * @param {string} conversationName * A fully-qualified path representing Conversation resource. * @returns {string} A string representing the conversation. */ matchConversationFromConversationName(conversationName: string): string | number; /** * Return a fully-qualified dataAgent resource name string. * * @param {string} project * @param {string} location * @param {string} data_agent * @returns {string} Resource name string. */ dataAgentPath(project: string, location: string, dataAgent: string): string; /** * Parse the project from DataAgent resource. * * @param {string} dataAgentName * A fully-qualified path representing DataAgent resource. * @returns {string} A string representing the project. */ matchProjectFromDataAgentName(dataAgentName: string): string | number; /** * Parse the location from DataAgent resource. * * @param {string} dataAgentName * A fully-qualified path representing DataAgent resource. * @returns {string} A string representing the location. */ matchLocationFromDataAgentName(dataAgentName: string): string | number; /** * Parse the data_agent from DataAgent resource. * * @param {string} dataAgentName * A fully-qualified path representing DataAgent resource. * @returns {string} A string representing the data_agent. */ matchDataAgentFromDataAgentName(dataAgentName: string): string | number; /** * Return a fully-qualified location resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ locationPath(project: string, location: string): string; /** * Parse the project from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the project. */ matchProjectFromLocationName(locationName: string): string | number; /** * Parse the location from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the location. */ matchLocationFromLocationName(locationName: 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; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }