@ibm-cloud/watsonx-data
Version:
IBM Cloud Watsonx.data Node.js SDK
980 lines • 263 kB
TypeScript
/**
* (C) Copyright IBM Corp. 2025.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/// <reference types="node" />
/// <reference types="node" />
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
import { AbortSignal, BaseService, UserOptions } from 'ibm-cloud-sdk-core';
/**
* This is the Public API for IBM watsonx.data
*
* API Version: 2.0.0
*/
declare class WatsonxDataV2 extends BaseService {
static DEFAULT_SERVICE_URL: string;
static DEFAULT_SERVICE_NAME: string;
/*************************
* Factory method
************************/
/**
* Constructs an instance of WatsonxDataV2 with passed in options and external configuration.
*
* @param {UserOptions} [options] - The parameters to send to the service.
* @param {string} [options.serviceName] - The name of the service to configure
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service
* @param {string} [options.serviceUrl] - The base URL for the service
* @returns {WatsonxDataV2}
*/
static newInstance(options: UserOptions): WatsonxDataV2;
/**
* Construct a WatsonxDataV2 object.
*
* @param {Object} options - Options for the service.
* @param {string} [options.serviceUrl] - The base URL for the service
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
* @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service
* @constructor
* @returns {WatsonxDataV2}
*/
constructor(options: UserOptions);
/*************************
* buckets
************************/
/**
* Get bucket registrations.
*
* Get list of registered buckets.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistrationCollection>>}
*/
listBucketRegistrations(params?: WatsonxDataV2.ListBucketRegistrationsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistrationCollection>>;
/**
* Register bucket.
*
* Register a new bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketType - bucket type.
* @param {string} params.description - bucket description.
* @param {string} params.managedBy - managed by.
* @param {BucketCatalog} [params.associatedCatalog] - bucket catalog.
* @param {BucketDetails} [params.bucketDetails] - bucket details.
* @param {string} [params.bucketDisplayName] - bucket display name.
* @param {string} [params.region] - region where the bucket is located.
* @param {StorageDetails} [params.storageDetails] - storage details.
* @param {string[]} [params.tags] - tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistration>>}
*/
createBucketRegistration(params: WatsonxDataV2.CreateBucketRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistration>>;
/**
* Get bucket.
*
* Get a registered bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistration>>}
*/
getBucketRegistration(params: WatsonxDataV2.GetBucketRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistration>>;
/**
* Deregister Bucket.
*
* Deregister a bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteBucketRegistration(params: WatsonxDataV2.DeleteBucketRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Update bucket.
*
* Update bucket details & credentials.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {BucketDetails} [params.bucketDetails] - bucket details.
* @param {string} [params.bucketDisplayName] - bucket display name.
* @param {string} [params.description] - modified description.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistration>>}
*/
updateBucketRegistration(params: WatsonxDataV2.UpdateBucketRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistration>>;
/**
* Activate Bucket.
*
* Activate a registered bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.CreateActivateBucketCreatedBody>>}
*/
createActivateBucket(params: WatsonxDataV2.CreateActivateBucketParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.CreateActivateBucketCreatedBody>>;
/**
* Add bucket catalog.
*
* Add bucket catalog.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.basePath] - catalog base path.
* @param {string} [params.catalogName] - catalog name.
* @param {string[]} [params.catalogTags] - catalog tags.
* @param {string} [params.catalogType] - catalog type.
* @param {string} [params.authInstanceId] - watsonx.data instance ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>}
*/
addBucketCatalog(params: WatsonxDataV2.AddBucketCatalogParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>;
/**
* Deactivate Bucket.
*
* Deactivate a bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteDeactivateBucket(params: WatsonxDataV2.DeleteDeactivateBucketParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* List bucket objects.
*
* Fetch all objects from a given bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {string} [params.authInstanceId] - CRN.
* @param {string} [params.path] - path.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistrationObjectCollection>>}
*/
listBucketObjects(params: WatsonxDataV2.ListBucketObjectsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketRegistrationObjectCollection>>;
/**
* Get bucket object properties.
*
* Get bucket object properties.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketId - bucket id.
* @param {Path[]} [params.paths] - bucket object size.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketObjectProperties>>}
*/
getBucketObjectProperties(params: WatsonxDataV2.GetBucketObjectPropertiesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.BucketObjectProperties>>;
/**
* Add/Create HDFS storage.
*
* Add or create a new HDFS database.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bucketDisplayName - Bucket display name.
* @param {string} params.bucketType - Bucket type.
* @param {string} params.hmsThriftUri - HMS Thrift URI.
* @param {number} params.hmsThriftPort - HMS Thrift Port.
* @param {string} params.coreSite - contents of core-site.xml file.
* @param {string} params.hdfsSite - contents of hdfs-site.xml file.
* @param {string} params.kerberos - Kerberos Flag.
* @param {string} params.catalogName - Catalog name.
* @param {string} params.catalogType - Catalog type.
* @param {string} [params.krb5Config] - Kerberos config file.
* @param {NodeJS.ReadableStream | Buffer} [params.hiveKeytab] - Hive keytab file.
* @param {string} [params.hiveKeytabContentType] - The content type of hiveKeytab.
* @param {NodeJS.ReadableStream | Buffer} [params.hdfsKeytab] - HDFS keytab file.
* @param {string} [params.hdfsKeytabContentType] - The content type of hdfsKeytab.
* @param {string} [params.hiveServerPrincipal] - Hive server principal.
* @param {string} [params.hiveClientPrincipal] - Hive client principal.
* @param {string} [params.hdfsPrincipal] - HDFS principal.
* @param {string} [params.description] - Database description.
* @param {string} [params.createdOn] - Created on.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.HdfsStorageRegistration>>}
*/
createHdfsStorage(params: WatsonxDataV2.CreateHdfsStorageParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.HdfsStorageRegistration>>;
/*************************
* databases
************************/
/**
* Get databases.
*
* Get list of databases.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistrationCollection>>}
*/
listDatabaseRegistrations(params?: WatsonxDataV2.ListDatabaseRegistrationsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistrationCollection>>;
/**
* Add/Create database.
*
* Add or create a new database.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseDisplayName - Database display name.
* @param {string} params.databaseType - Connector type.
* @param {DatabaseCatalog} [params.associatedCatalog] - database catalog.
* @param {string} [params.createdOn] - Created on.
* @param {DatabaseDetails} [params.databaseDetails] - database details.
* @param {DatabaseRegistrationPrototypeDatabasePropertiesItems[]} [params.databaseProperties] - This will hold all
* the properties for a custom database.
* @param {string} [params.description] - Database description.
* @param {string[]} [params.tags] - tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistration>>}
*/
createDatabaseRegistration(params: WatsonxDataV2.CreateDatabaseRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistration>>;
/**
* Get database.
*
* Get a registered databases.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseId - database id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistration>>}
*/
getDatabase(params: WatsonxDataV2.GetDatabaseParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistration>>;
/**
* Delete database.
*
* Delete a database.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseId - database id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteDatabaseCatalog(params: WatsonxDataV2.DeleteDatabaseCatalogParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Update database.
*
* Update database details.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.databaseId - database id.
* @param {DatabaseRegistrationPatchDatabaseDetails} [params.databaseDetails] - New database details.
* @param {string} [params.databaseDisplayName] - New database display name.
* @param {string} [params.description] - New database description.
* @param {string[]} [params.tags] - New tags.
* @param {DatabaseRegistrationPatchTopicsItems[]} [params.topics] - List of topics.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistration>>}
*/
updateDatabase(params: WatsonxDataV2.UpdateDatabaseParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.DatabaseRegistration>>;
/*************************
* drivers
************************/
/**
* Get drivers.
*
* Get all driver details.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.DriverRegistrationCollection>>}
*/
listDriverRegistration(params?: WatsonxDataV2.ListDriverRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.DriverRegistrationCollection>>;
/**
* Register driver.
*
* Register a new driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {NodeJS.ReadableStream | Buffer} params.driver - Driver file to upload.
* @param {string} params.driverName - Driver name.
* @param {string} params.connectionType - Driver connection type.
* @param {string} [params.driverContentType] - The content type of driver.
* @param {string} [params.version] - Driver status.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.DriverRegistration>>}
*/
createDriverRegistration(params: WatsonxDataV2.CreateDriverRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.DriverRegistration>>;
/**
* Delete driver.
*
* Delete a driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.driverId - Driver ID.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteDriverRegistration(params: WatsonxDataV2.DeleteDriverRegistrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Disassociate engines from driver.
*
* Disassociate one or more engines from a driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.driverId - driver id.
* @param {string} params.engineIds - Engine id(s) to be disassociated from the driver, comma separated.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteDriverEngines(params: WatsonxDataV2.DeleteDriverEnginesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Associate engines to driver.
*
* Associate one or more engines to a driver.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.driverId - driver id.
* @param {string[]} [params.engines] - List of engine IDs.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.DriverRegistrationEngine>>}
*/
updateDriverEngines(params: WatsonxDataV2.UpdateDriverEnginesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.DriverRegistrationEngine>>;
/*************************
* otherEngines
************************/
/**
* List other engines.
*
* list all other engine details.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.OtherEngineCollection>>}
*/
listOtherEngines(params?: WatsonxDataV2.ListOtherEnginesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.OtherEngineCollection>>;
/**
* Create other engine.
*
* Create a new engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {OtherEngineDetailsBody} params.engineDetails - External engine details.
* @param {string} params.engineDisplayName - engine display name.
* @param {string} [params.description] - engine description.
* @param {string} [params.origin] - Origin - created or registered.
* @param {string[]} [params.tags] - other engine tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.OtherEngine>>}
*/
createOtherEngine(params: WatsonxDataV2.CreateOtherEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.OtherEngine>>;
/**
* Delete engine.
*
* Delete an engine from lakehouse.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteOtherEngine(params: WatsonxDataV2.DeleteOtherEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/*************************
* integrations
************************/
/**
* Get all existing Integrations.
*
* Get all existing Integrations.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {string} [params.secret] - API Authentication service token.
* @param {string} [params.serviceType] - service_type.
* @param {string[]} [params.state] - state.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.IntegrationCollection>>}
*/
listAllIntegrations(params?: WatsonxDataV2.ListAllIntegrationsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.IntegrationCollection>>;
/**
* To register an integration.
*
* To register an integration.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.accessToken] - token for databand.
* @param {string} [params.apikey] - Integration APIKEY.
* @param {boolean} [params.crossAccountIntegration] - cross account integration enabler/disabler.
* @param {boolean} [params.enableDataPolicyWithinWxd] - data policy enabler with wxd for ranger.
* @param {string} [params.ikcUserAccountId] - token for ikc.
* @param {string} [params.password] - Integration password.
* @param {string} [params.resource] - resouce for ranger.
* @param {string} [params.serviceType] - Integration type.
* @param {string[]} [params.storageCatalogs] - Comma separated list of bucket catalogs which have ikc enabled.
* @param {string} [params.url] - Integration Connection URL.
* @param {string} [params.username] - Integration username.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Integration>>}
*/
createIntegration(params?: WatsonxDataV2.CreateIntegrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Integration>>;
/**
* Get an Integration.
*
* Get an Integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.integrationId - integration_id.
* @param {string} [params.authInstanceId] - CRN.
* @param {string} [params.secret] - API Authentication service token.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Integration>>}
*/
getIntegrations(params: WatsonxDataV2.GetIntegrationsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Integration>>;
/**
* Remove an Integration.
*
* Remove an Integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.integrationId - integration_id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteIntegration(params: WatsonxDataV2.DeleteIntegrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Update an existing Integration.
*
* Update an existing Integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.integrationId - integration_id.
* @param {string} [params.accessToken] - token for databand.
* @param {string} [params.apikey] - Integration APIKEY.
* @param {boolean} [params.crossAccountIntegration] - cross account integration enabler/disabler.
* @param {boolean} [params.enableDataPolicyWithinWxd] - data policy enabler with wxd for ranger.
* @param {string} [params.ikcUserAccountId] - token for databand.
* @param {string} [params.password] - Integration password.
* @param {string} [params.resource] - resouce for ranger.
* @param {string} [params.state] - current state.
* @param {string[]} [params.storageCatalogs] - Comma separated list of bucket catalogs which have ikc enabled.
* @param {string} [params.url] - Integration Connection URL.
* @param {string} [params.username] - Integration username.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Integration>>}
*/
updateIntegration(params: WatsonxDataV2.UpdateIntegrationParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Integration>>;
/*************************
* db2Engines
************************/
/**
* Get list of db2 engines.
*
* Get list of all db2 engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Db2EngineCollection>>}
*/
listDb2Engines(params?: WatsonxDataV2.ListDb2EnginesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Db2EngineCollection>>;
/**
* Create db2 engine.
*
* Create a new db2 engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string} [params.description] - Engine description.
* @param {Db2EngineDetailsBody} [params.engineDetails] - External engine details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Db2Engine>>}
*/
createDb2Engine(params: WatsonxDataV2.CreateDb2EngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Db2Engine>>;
/**
* Delete db2 engine.
*
* Delete a db2 engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteDb2Engine(params: WatsonxDataV2.DeleteDb2EngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Update db2 engine.
*
* Update details of db2 engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Db2Engine>>}
*/
updateDb2Engine(params: WatsonxDataV2.UpdateDb2EngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Db2Engine>>;
/*************************
* netezzaEngines
************************/
/**
* Get list of netezza engines.
*
* Get list of all netezza engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.NetezzaEngineCollection>>}
*/
listNetezzaEngines(params?: WatsonxDataV2.ListNetezzaEnginesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.NetezzaEngineCollection>>;
/**
* Create netezza engine.
*
* Create a new netezza engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string} [params.description] - Engine description.
* @param {NetezzaEngineDetailsBody} [params.engineDetails] - External engine details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.NetezzaEngine>>}
*/
createNetezzaEngine(params: WatsonxDataV2.CreateNetezzaEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.NetezzaEngine>>;
/**
* Delete netezza engine.
*
* Delete a netezza engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteNetezzaEngine(params: WatsonxDataV2.DeleteNetezzaEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Update netezza engine.
*
* Update details of netezza engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.NetezzaEngine>>}
*/
updateNetezzaEngine(params: WatsonxDataV2.UpdateNetezzaEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.NetezzaEngine>>;
/*************************
* queries
************************/
/**
* Execute a query.
*
* Execute a query.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine name.
* @param {string} params.sqlString - query to be executed.
* @param {string} [params.catalogName] - Name of the catalog.
* @param {string} [params.schemaName] - Schema name.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.ExecuteQueryCreatedBody>>}
*/
createExecuteQuery(params: WatsonxDataV2.CreateExecuteQueryParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.ExecuteQueryCreatedBody>>;
/*************************
* instance
************************/
/**
* Get all instance details.
*
* Get all engine details.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.WatsonxInstanceDetailsCollection>>}
*/
listInstanceDetails(params?: WatsonxDataV2.ListInstanceDetailsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.WatsonxInstanceDetailsCollection>>;
/**
* Get engines and services detail.
*
* Get engines and services detail.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.target - Target type (e.g., 'cpd', 'generic').
* @param {boolean} [params.internalHost] - Internal host.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EnginesServicesDetails>>}
*/
listInstanceServiceDetails(params: WatsonxDataV2.ListInstanceServiceDetailsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EnginesServicesDetails>>;
/**
* Get services details.
*
* Get services details for a given engine or service type.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.target - Target type (e.g., 'cpd', 'generic').
* @param {string} params.engineOrServiceType - Type of engine or service (e.g., 'milvus', 'presto').
* @param {boolean} [params.internalHost] - Internal host.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.ServicesDetails>>}
*/
getServicesDetails(params: WatsonxDataV2.GetServicesDetailsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.ServicesDetails>>;
/**
* Get Milvus service detail.
*
* Get Milvus service detail.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.target - Target type (e.g., 'cpd', 'generic').
* @param {string} params.engineOrServiceType - Type of engine or service (e.g., 'milvus', 'presto').
* @param {string} params.id - Service ID.
* @param {string} [params.database] - Database name in milvus.
* @param {boolean} [params.internalHost] - Internal host.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.ConnectionPropertiesDetails>>}
*/
getServiceDetail(params: WatsonxDataV2.GetServiceDetailParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.ConnectionPropertiesDetails>>;
/*************************
* prestissimoEngines
************************/
/**
* Get list of prestissimo engines.
*
* Get list of all prestissimo engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngineCollection>>}
*/
listPrestissimoEngines(params?: WatsonxDataV2.ListPrestissimoEnginesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngineCollection>>;
/**
* Create prestissimo engine.
*
* Create a new prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string[]} [params.associatedCatalogs] - Associated catalogs.
* @param {string} [params.description] - Engine description.
* @param {PrestissimoEngineDetails} [params.engineDetails] - External engine details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string} [params.region] - Region (cloud).
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.version] - Version like 0.278 for prestissimo or else.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngine>>}
*/
createPrestissimoEngine(params: WatsonxDataV2.CreatePrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngine>>;
/**
* Get prestissimo engine.
*
* Get details of one prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngine>>}
*/
getPrestissimoEngine(params: WatsonxDataV2.GetPrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngine>>;
/**
* Delete prestissimo engine.
*
* Delete a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deletePrestissimoEngine(params: WatsonxDataV2.DeletePrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Update prestissimo engine.
*
* Update details of prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {PrestissimoEngineEngineProperties} [params.engineProperties] - Engine properties.
* @param {string} [params.engineRestart] - Triggers engine restart if value is force.
* @param {RemoveEngineProperties} [params.removeEngineProperties] - RemoveEngine properties.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngine>>}
*/
updatePrestissimoEngine(params: WatsonxDataV2.UpdatePrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestissimoEngine>>;
/**
* Get prestissimo engine catalogs.
*
* Get list of all catalogs attached a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.CatalogCollection>>}
*/
listPrestissimoEngineCatalogs(params: WatsonxDataV2.ListPrestissimoEngineCatalogsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.CatalogCollection>>;
/**
* Associate catalogs to a prestissimo engine.
*
* Associate one or more catalogs to a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.catalogName] - catalog names.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Catalog>>}
*/
createPrestissimoEngineCatalogs(params: WatsonxDataV2.CreatePrestissimoEngineCatalogsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Catalog>>;
/**
* Disassociate catalogs from a prestissimo engine.
*
* Disassociate one or more catalogs from a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogNames - Catalog id(s) to be stopped, comma separated.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deletePrestissimoEngineCatalogs(params: WatsonxDataV2.DeletePrestissimoEngineCatalogsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Get prestissimo engine catalog.
*
* Get catalog attached to a prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} params.catalogId - catalog id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.Catalog>>}
*/
getPrestissimoEngineCatalog(params: WatsonxDataV2.GetPrestissimoEngineCatalogParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.Catalog>>;
/**
* Pause prestissimo engine.
*
* Pause a running prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>}
*/
pausePrestissimoEngine(params: WatsonxDataV2.PausePrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>;
/**
* Explain query.
*
* Explain a query statement.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine id.
* @param {string} params.statement - Presto query to determine explain plan.
* @param {string} [params.format] - Format.
* @param {string} [params.type] - Type.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.ResultPrestissimoExplainStatement>>}
*/
runPrestissimoExplainStatement(params: WatsonxDataV2.RunPrestissimoExplainStatementParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.ResultPrestissimoExplainStatement>>;
/**
* Explain analyze.
*
* Return query metrics after query is complete.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - Engine id.
* @param {string} params.statement - Presto query to show explain analyze.
* @param {boolean} [params.verbose] - Verbose.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.ResultRunPrestissimoExplainAnalyzeStatement>>}
*/
runPrestissimoExplainAnalyzeStatement(params: WatsonxDataV2.RunPrestissimoExplainAnalyzeStatementParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.ResultRunPrestissimoExplainAnalyzeStatement>>;
/**
* Restart a prestissimo engine.
*
* Restart an existing prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>}
*/
restartPrestissimoEngine(params: WatsonxDataV2.RestartPrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>;
/**
* Resume prestissimo engine.
*
* Resume a paused prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>}
*/
resumePrestissimoEngine(params: WatsonxDataV2.ResumePrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>;
/**
* Scale a prestissimo engine.
*
* Scale an existing prestissimo engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {PrestissimoNodeDescriptionBody} [params.coordinator] - coordinator/worker property settings.
* @param {PrestissimoNodeDescriptionBody} [params.worker] - coordinator/worker property settings.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>}
*/
scalePrestissimoEngine(params: WatsonxDataV2.ScalePrestissimoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.SuccessResponse>>;
/*************************
* prestoEngines
************************/
/**
* Get list of presto engines.
*
* Get list of all presto engines.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngineCollection>>}
*/
listPrestoEngines(params?: WatsonxDataV2.ListPrestoEnginesParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngineCollection>>;
/**
* Create presto engine.
*
* Create a new presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.origin - Origin - created or registered.
* @param {string[]} [params.associatedCatalogs] - Associated catalogs.
* @param {string} [params.description] - Engine description.
* @param {EngineDetailsBody} [params.engineDetails] - Node details.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {string} [params.region] - Region (cloud).
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.version] - Version like 0.278 for presto or else.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngine>>}
*/
createPrestoEngine(params: WatsonxDataV2.CreatePrestoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngine>>;
/**
* Get presto engine.
*
* Get details of one presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngine>>}
*/
getPrestoEngine(params: WatsonxDataV2.GetPrestoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngine>>;
/**
* Delete presto engine.
*
* Delete a presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>}
*/
deleteEngine(params: WatsonxDataV2.DeleteEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.EmptyObject>>;
/**
* Update presto engine.
*
* Update details of presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.description] - Modified description.
* @param {string} [params.engineDisplayName] - Engine display name.
* @param {PrestoEngineEngineProperties} [params.engineProperties] - Engine properties.
* @param {string} [params.engineRestart] - Triggers engine restart if value is force.
* @param {PrestoEnginePatchRemoveEngineProperties} [params.removeEngineProperties] - RemoveEngine properties.
* @param {string[]} [params.tags] - Tags.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngine>>}
*/
updatePrestoEngine(params: WatsonxDataV2.UpdatePrestoEngineParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.PrestoEngine>>;
/**
* Get presto engine catalogs.
*
* Get list of all catalogs attached to a presto engine.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.engineId - engine id.
* @param {string} [params.authInstanceId] - CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise<WatsonxDataV2.Response<WatsonxDataV2.CatalogCollection>>}
*/
listPrestoEngineCatalogs(params: WatsonxDataV2.ListPrestoEngineCatalogsParams): Promise<WatsonxDataV2.Response<WatsonxDataV2.CatalogCollection>>;
/**
* Associate catalogs to presto engine.
*
* Associate one or more catalogs to a presto engine.
*
* @param {Object} params - The par