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 describing handlers for resources. * @class * @memberof v1 */ export declare class DataAgentServiceClient { 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; dataAgentServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of DataAgentServiceClient. * * @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 DataAgentServiceClient({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; /** * Gets details of a single DataAgent. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the resource. * @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.v1.DataAgent|DataAgent}. * 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/v1/data_agent_service.get_data_agent.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_GetDataAgent_async */ getDataAgent(request?: protos.google.cloud.geminidataanalytics.v1.IGetDataAgentRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1.IDataAgent, (protos.google.cloud.geminidataanalytics.v1.IGetDataAgentRequest | undefined), {} | undefined ]>; getDataAgent(request: protos.google.cloud.geminidataanalytics.v1.IGetDataAgentRequest, options: CallOptions, callback: Callback): void; getDataAgent(request: protos.google.cloud.geminidataanalytics.v1.IGetDataAgentRequest, callback: Callback): void; /** * Creates a new DataAgent in a given project and location synchronously. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Value for parent. * @param {string} [request.dataAgentId] * Optional. Id of the requesting object. 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.v1.DataAgent} request.dataAgent * Required. The resource being created. * @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. * * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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.v1.DataAgent|DataAgent}. * 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/v1/data_agent_service.create_data_agent_sync.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_CreateDataAgentSync_async */ createDataAgentSync(request?: protos.google.cloud.geminidataanalytics.v1.ICreateDataAgentRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1.IDataAgent, (protos.google.cloud.geminidataanalytics.v1.ICreateDataAgentRequest | undefined), {} | undefined ]>; createDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1.ICreateDataAgentRequest, options: CallOptions, callback: Callback): void; createDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1.ICreateDataAgentRequest, callback: Callback): void; /** * Updates the parameters of a single DataAgent synchronously. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Field mask is used to specify the fields to be overwritten in the * DataAgent resource by the update. * The fields specified in the update_mask are relative to the resource, not * the full request. A field will be overwritten if it is in the mask. If the * user does not provide a mask then all fields with non-default values * present in the request will be overwritten. If a wildcard mask is provided, * all fields will be overwritten. * @param {google.cloud.geminidataanalytics.v1.DataAgent} request.dataAgent * Required. The resource being updated. * @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. * * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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.v1.DataAgent|DataAgent}. * 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/v1/data_agent_service.update_data_agent_sync.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_UpdateDataAgentSync_async */ updateDataAgentSync(request?: protos.google.cloud.geminidataanalytics.v1.IUpdateDataAgentRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1.IDataAgent, (protos.google.cloud.geminidataanalytics.v1.IUpdateDataAgentRequest | undefined), {} | undefined ]>; updateDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1.IUpdateDataAgentRequest, options: CallOptions, callback: Callback): void; updateDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1.IUpdateDataAgentRequest, callback: Callback): void; /** * Deletes a single DataAgent synchronously. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the resource. * @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 after the first request. * * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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/v1/data_agent_service.delete_data_agent_sync.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_DeleteDataAgentSync_async */ deleteDataAgentSync(request?: protos.google.cloud.geminidataanalytics.v1.IDeleteDataAgentRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.geminidataanalytics.v1.IDeleteDataAgentRequest | undefined), {} | undefined ]>; deleteDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1.IDeleteDataAgentRequest, options: CallOptions, callback: Callback): void; deleteDataAgentSync(request: protos.google.cloud.geminidataanalytics.v1.IDeleteDataAgentRequest, callback: Callback): void; /** * Gets the IAM policy for DataAgent * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.GetPolicyOptions} request.options * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. * @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.iam.v1.Policy|Policy}. * 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/v1/data_agent_service.get_iam_policy.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_GetIamPolicy_async */ getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback): void; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback): void; /** * Sets the IAM policy for a DataAgent. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being specified. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.Policy} request.policy * REQUIRED: The complete policy to be applied to the `resource`. The size of * the policy is limited to a few 10s of KB. An empty policy is a * valid policy but certain Cloud Platform services (such as Projects) * might reject them. * @param {google.protobuf.FieldMask} request.updateMask * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only * the fields in the mask will be modified. If no mask is provided, the * following default mask is used: * * `paths: "bindings, etag"` * @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.iam.v1.Policy|Policy}. * 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/v1/data_agent_service.set_iam_policy.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_SetIamPolicy_async */ setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback): void; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback): void; /** * Creates a new DataAgent in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Value for parent. * @param {string} [request.dataAgentId] * Optional. Id of the requesting object. 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.v1.DataAgent} request.dataAgent * Required. The resource being created. * @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. * * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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 include:samples/generated/v1/data_agent_service.create_data_agent.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_CreateDataAgent_async */ createDataAgent(request?: protos.google.cloud.geminidataanalytics.v1.ICreateDataAgentRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createDataAgent(request: protos.google.cloud.geminidataanalytics.v1.ICreateDataAgentRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createDataAgent(request: protos.google.cloud.geminidataanalytics.v1.ICreateDataAgentRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createDataAgent()`. * @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 include:samples/generated/v1/data_agent_service.create_data_agent.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_CreateDataAgent_async */ checkCreateDataAgentProgress(name: string): Promise>; /** * Updates the parameters of a single DataAgent. * * @param {Object} request * The request object that will be sent. * @param {google.protobuf.FieldMask} [request.updateMask] * Optional. Field mask is used to specify the fields to be overwritten in the * DataAgent resource by the update. * The fields specified in the update_mask are relative to the resource, not * the full request. A field will be overwritten if it is in the mask. If the * user does not provide a mask then all fields with non-default values * present in the request will be overwritten. If a wildcard mask is provided, * all fields will be overwritten. * @param {google.cloud.geminidataanalytics.v1.DataAgent} request.dataAgent * Required. The resource being updated. * @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. * * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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 include:samples/generated/v1/data_agent_service.update_data_agent.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_UpdateDataAgent_async */ updateDataAgent(request?: protos.google.cloud.geminidataanalytics.v1.IUpdateDataAgentRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateDataAgent(request: protos.google.cloud.geminidataanalytics.v1.IUpdateDataAgentRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateDataAgent(request: protos.google.cloud.geminidataanalytics.v1.IUpdateDataAgentRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateDataAgent()`. * @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 include:samples/generated/v1/data_agent_service.update_data_agent.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_UpdateDataAgent_async */ checkUpdateDataAgentProgress(name: string): Promise>; /** * Deletes a single DataAgent. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the resource. * @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 after the first request. * * For example, consider a situation where you make an initial request and the * request times out. If you make the request again with the same request * ID, the server can check if original operation with the same request ID * was received, and if so, will ignore the second request. This prevents * clients from accidentally creating duplicate commitments. * * The request ID must be a valid UUID with the exception that zero UUID is * not supported (00000000-0000-0000-0000-000000000000). * @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 include:samples/generated/v1/data_agent_service.delete_data_agent.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_DeleteDataAgent_async */ deleteDataAgent(request?: protos.google.cloud.geminidataanalytics.v1.IDeleteDataAgentRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteDataAgent(request: protos.google.cloud.geminidataanalytics.v1.IDeleteDataAgentRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteDataAgent(request: protos.google.cloud.geminidataanalytics.v1.IDeleteDataAgentRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteDataAgent()`. * @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 include:samples/generated/v1/data_agent_service.delete_data_agent.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_DeleteDataAgent_async */ checkDeleteDataAgentProgress(name: string): Promise>; /** * Lists DataAgents in a given project and location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent value for ListDataAgentsRequest. * @param {number} [request.pageSize] * Optional. Server may return fewer items than requested. * If unspecified, server will pick an appropriate default. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListDataAgents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListDataAgents` must * match the call that provided the page token. The service may return fewer * than this value. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * @param {string} [request.orderBy] * Optional. User specification for how to order the results. * @param {boolean} [request.showDeleted] * Optional. If true, the list results will include soft-deleted DataAgents. * Defaults to false. * @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.v1.DataAgent|DataAgent}. * 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 `listDataAgentsAsync()` * 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. */ listDataAgents(request?: protos.google.cloud.geminidataanalytics.v1.IListDataAgentsRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1.IDataAgent[], protos.google.cloud.geminidataanalytics.v1.IListDataAgentsRequest | null, protos.google.cloud.geminidataanalytics.v1.IListDataAgentsResponse ]>; listDataAgents(request: protos.google.cloud.geminidataanalytics.v1.IListDataAgentsRequest, options: CallOptions, callback: PaginationCallback): void; listDataAgents(request: protos.google.cloud.geminidataanalytics.v1.IListDataAgentsRequest, callback: PaginationCallback): void; /** * Equivalent to `listDataAgents`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent value for ListDataAgentsRequest. * @param {number} [request.pageSize] * Optional. Server may return fewer items than requested. * If unspecified, server will pick an appropriate default. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListDataAgents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListDataAgents` must * match the call that provided the page token. The service may return fewer * than this value. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * @param {string} [request.orderBy] * Optional. User specification for how to order the results. * @param {boolean} [request.showDeleted] * Optional. If true, the list results will include soft-deleted DataAgents. * Defaults to false. * @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.v1.DataAgent|DataAgent} 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 `listDataAgentsAsync()` * 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. */ listDataAgentsStream(request?: protos.google.cloud.geminidataanalytics.v1.IListDataAgentsRequest, options?: CallOptions): Transform; /** * Equivalent to `listDataAgents`, 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 ListDataAgentsRequest. * @param {number} [request.pageSize] * Optional. Server may return fewer items than requested. * If unspecified, server will pick an appropriate default. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListDataAgents` call. * Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to `ListDataAgents` must * match the call that provided the page token. The service may return fewer * than this value. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * @param {string} [request.orderBy] * Optional. User specification for how to order the results. * @param {boolean} [request.showDeleted] * Optional. If true, the list results will include soft-deleted DataAgents. * Defaults to false. * @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.v1.DataAgent|DataAgent}. 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/v1/data_agent_service.list_data_agents.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_ListDataAgents_async */ listDataAgentsAsync(request?: protos.google.cloud.geminidataanalytics.v1.IListDataAgentsRequest, options?: CallOptions): AsyncIterable; /** * Lists DataAgents that are accessible to the caller in a given project and * location. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent value for ListAccessibleDataAgentsRequest. * @param {number} [request.pageSize] * Optional. Server may return fewer items than requested. * If unspecified, server will pick an appropriate default. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListAccessibleDataAgents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListAccessibleDataAgents` must match the call that provided the page * token. The service may return fewer than this value. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * @param {string} [request.orderBy] * Optional. User specification for how to order the results. * @param {boolean} [request.showDeleted] * Optional. If true, the list results will include soft-deleted DataAgents. * Defaults to false. * @param {google.cloud.geminidataanalytics.v1.ListAccessibleDataAgentsRequest.CreatorFilter} [request.creatorFilter] * Optional. Filter for the creator of the agent. * @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.v1.DataAgent|DataAgent}. * 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 `listAccessibleDataAgentsAsync()` * 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. */ listAccessibleDataAgents(request?: protos.google.cloud.geminidataanalytics.v1.IListAccessibleDataAgentsRequest, options?: CallOptions): Promise<[ protos.google.cloud.geminidataanalytics.v1.IDataAgent[], protos.google.cloud.geminidataanalytics.v1.IListAccessibleDataAgentsRequest | null, protos.google.cloud.geminidataanalytics.v1.IListAccessibleDataAgentsResponse ]>; listAccessibleDataAgents(request: protos.google.cloud.geminidataanalytics.v1.IListAccessibleDataAgentsRequest, options: CallOptions, callback: PaginationCallback): void; listAccessibleDataAgents(request: protos.google.cloud.geminidataanalytics.v1.IListAccessibleDataAgentsRequest, callback: PaginationCallback): void; /** * Equivalent to `listAccessibleDataAgents`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Parent value for ListAccessibleDataAgentsRequest. * @param {number} [request.pageSize] * Optional. Server may return fewer items than requested. * If unspecified, server will pick an appropriate default. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListAccessibleDataAgents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListAccessibleDataAgents` must match the call that provided the page * token. The service may return fewer than this value. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * @param {string} [request.orderBy] * Optional. User specification for how to order the results. * @param {boolean} [request.showDeleted] * Optional. If true, the list results will include soft-deleted DataAgents. * Defaults to false. * @param {google.cloud.geminidataanalytics.v1.ListAccessibleDataAgentsRequest.CreatorFilter} [request.creatorFilter] * Optional. Filter for the creator of the agent. * @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.v1.DataAgent|DataAgent} 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 `listAccessibleDataAgentsAsync()` * 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. */ listAccessibleDataAgentsStream(request?: protos.google.cloud.geminidataanalytics.v1.IListAccessibleDataAgentsRequest, options?: CallOptions): Transform; /** * Equivalent to `listAccessibleDataAgents`, 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 ListAccessibleDataAgentsRequest. * @param {number} [request.pageSize] * Optional. Server may return fewer items than requested. * If unspecified, server will pick an appropriate default. * @param {string} [request.pageToken] * Optional. A page token, received from a previous `ListAccessibleDataAgents` * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * `ListAccessibleDataAgents` must match the call that provided the page * token. The service may return fewer than this value. * @param {string} [request.filter] * Optional. Filtering results. See [AIP-160](https://google.aip.dev/160) for * syntax. * @param {string} [request.orderBy] * Optional. User specification for how to order the results. * @param {boolean} [request.showDeleted] * Optional. If true, the list results will include soft-deleted DataAgents. * Defaults to false. * @param {google.cloud.geminidataanalytics.v1.ListAccessibleDataAgentsRequest.CreatorFilter} [request.creatorFilter] * Optional. Filter for the creator of the agent. * @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.v1.DataAgent|DataAgent}. 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/v1/data_agent_service.list_accessible_data_agents.js * region_tag:geminidataanalytics_v1_generated_DataAgentService_ListAccessibleDataAgents_async */ listAccessibleDataAgentsAsync(request?: protos.google.cloud.geminidataanalytics.v1.IListAccessibleDataAgentsRequest, 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; /** * 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, callback?: Callback): 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; /** * 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, callback?: Callback): Promise; /** * 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, callback?: Callback): Promise; /** * 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; }