IBM Cloud API Docs

Introduction

Last updated: 2023-07-10

IBM® watsonx.data is a data management solution for collecting, storing, querying, and analyzing all your enterprise data (structured, semi-structured, and unstructured) with a single unified data platform. It provides a flexible and reliable platform that is optimized to work on open data formats.

The api are in beta state and expected to change.

Endpoint URLs

The base URLs come from the service instance. To find the URL, view the service credentials by clicking the name of the service in the Resource list. Use the value of the URL. Add the method to form the complete API endpoint for your request.

Authentication

Required Purpose: To work with the API, you must use an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.

You can generate an IAM token for an authenticated user or service ID by using the IAM Identity Services API. IAM tokens are generated by using the user or service ID's API key. For more information, see Generating an IBM Cloud IAM token by using an API key.

To use the API, add a valid IAM token to the HTTP Authorization request header, for example, -H 'Authorization: Bearer {TOKEN}'.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey={API_KEY}'

Replace {API_KEY} with your IAM API key.

Auditing

Required if applicable Purpose: Describes that the API generates auditing events that can be consumed by the Activity Tracker service, and links to your related product docs for more information. Required only if any of the API's methods is enabled to generate auditing events.

Example:

You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.

For more information about how to track Certificate Manager activity, see Auditing events for Certificate Manager.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP Error Code Description Recovery
200 Success The request was successful.
201 Created The requested resource successfully created in a synchronous manner.
204 No Content The server successfully processed the request and is not returning any content.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized to access '{namespace}'.
404 Not Found The requested resource could not be found.
409 Conflict The entity is already in the requested state.
500 Internal Server Error Your request could not be processed. Wait a few minutes and try again.

Pagination

Some API requests might return many results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the following resources use pagination:

  • /v1/statement

For the request that uses pagination, the response does include following urls to make subsequent requests :

  • infoUri: The URL for requesting the first page of results.
  • nextUri: The URL for requesting the next page of results.

Methods

Get bucket registrations

Get list of registered buckets

Get list of registered buckets.

Get list of registered buckets.

Get list of registered buckets.

Get list of registered buckets.

GET /bucket_registrations
(watsonxData *WatsonxDataV2) ListBucketRegistrations(listBucketRegistrationsOptions *ListBucketRegistrationsOptions) (result *BucketRegistrationCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListBucketRegistrationsWithContext(ctx context.Context, listBucketRegistrationsOptions *ListBucketRegistrationsOptions) (result *BucketRegistrationCollection, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistrationCollection> listBucketRegistrations(ListBucketRegistrationsOptions listBucketRegistrationsOptions)
list_bucket_registrations(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listBucketRegistrations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.bucket_registration.list

Register bucket

Register a new bucket

Register a new bucket.

Register a new bucket.

Register a new bucket.

Register a new bucket.

POST /bucket_registrations
(watsonxData *WatsonxDataV2) CreateBucketRegistration(createBucketRegistrationOptions *CreateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateBucketRegistrationWithContext(ctx context.Context, createBucketRegistrationOptions *CreateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistration> createBucketRegistration(CreateBucketRegistrationOptions createBucketRegistrationOptions)
create_bucket_registration(
        self,
        bucket_type: str,
        description: str,
        managed_by: str,
        *,
        associated_catalog: Optional['BucketCatalog'] = None,
        bucket_details: Optional['BucketDetails'] = None,
        bucket_display_name: Optional[str] = None,
        region: Optional[str] = None,
        storage_details: Optional['StorageDetails'] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.bucket_registration.create

Get bucket

Get a registered bucket

Get a registered bucket.

Get a registered bucket.

Get a registered bucket.

Get a registered bucket.

GET /bucket_registrations/{bucket_id}
(watsonxData *WatsonxDataV2) GetBucketRegistration(getBucketRegistrationOptions *GetBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetBucketRegistrationWithContext(ctx context.Context, getBucketRegistrationOptions *GetBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistration> getBucketRegistration(GetBucketRegistrationOptions getBucketRegistrationOptions)
get_bucket_registration(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Deregister Bucket

Deregister a bucket

Deregister a bucket.

Deregister a bucket.

Deregister a bucket.

Deregister a bucket.

DELETE /bucket_registrations/{bucket_id}
(watsonxData *WatsonxDataV2) DeleteBucketRegistration(deleteBucketRegistrationOptions *DeleteBucketRegistrationOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteBucketRegistrationWithContext(ctx context.Context, deleteBucketRegistrationOptions *DeleteBucketRegistrationOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteBucketRegistration(DeleteBucketRegistrationOptions deleteBucketRegistrationOptions)
delete_bucket_registration(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update bucket

Update bucket details & credentials

Update bucket details & credentials.

Update bucket details & credentials.

Update bucket details & credentials.

Update bucket details & credentials.

PATCH /bucket_registrations/{bucket_id}
(watsonxData *WatsonxDataV2) UpdateBucketRegistration(updateBucketRegistrationOptions *UpdateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateBucketRegistrationWithContext(ctx context.Context, updateBucketRegistrationOptions *UpdateBucketRegistrationOptions) (result *BucketRegistration, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistration> updateBucketRegistration(UpdateBucketRegistrationOptions updateBucketRegistrationOptions)
update_bucket_registration(
        self,
        bucket_id: str,
        body: 'BucketRegistrationPatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateBucketRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.bucket_registration.update

Activate Bucket

Activate a registered bucket

Activate a registered bucket.

Activate a registered bucket.

Activate a registered bucket.

Activate a registered bucket.

POST /bucket_registrations/{bucket_id}/activate
(watsonxData *WatsonxDataV2) CreateActivateBucket(createActivateBucketOptions *CreateActivateBucketOptions) (result *CreateActivateBucketCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateActivateBucketWithContext(ctx context.Context, createActivateBucketOptions *CreateActivateBucketOptions) (result *CreateActivateBucketCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<CreateActivateBucketCreatedBody> createActivateBucket(CreateActivateBucketOptions createActivateBucketOptions)
create_activate_bucket(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createActivateBucket(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Add bucket catalog

Add bucket catalog

Add bucket catalog.

Add bucket catalog.

Add bucket catalog.

Add bucket catalog.

POST /bucket_registrations/{bucket_id}/catalogs
(watsonxData *WatsonxDataV2) AddBucketCatalog(addBucketCatalogOptions *AddBucketCatalogOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) AddBucketCatalogWithContext(ctx context.Context, addBucketCatalogOptions *AddBucketCatalogOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> addBucketCatalog(AddBucketCatalogOptions addBucketCatalogOptions)
add_bucket_catalog(
        self,
        bucket_id: str,
        *,
        base_path: Optional[str] = None,
        catalog_name: Optional[str] = None,
        catalog_tags: Optional[List[str]] = None,
        catalog_type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
addBucketCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.catalog.create

Deactivate Bucket

Deactivate a bucket

Deactivate a bucket.

Deactivate a bucket.

Deactivate a bucket.

Deactivate a bucket.

DELETE /bucket_registrations/{bucket_id}/deactivate
(watsonxData *WatsonxDataV2) DeleteDeactivateBucket(deleteDeactivateBucketOptions *DeleteDeactivateBucketOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteDeactivateBucketWithContext(ctx context.Context, deleteDeactivateBucketOptions *DeleteDeactivateBucketOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteDeactivateBucket(DeleteDeactivateBucketOptions deleteDeactivateBucketOptions)
delete_deactivate_bucket(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteDeactivateBucket(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

List bucket objects

Fetch all objects from a given bucket

Fetch all objects from a given bucket.

Fetch all objects from a given bucket.

Fetch all objects from a given bucket.

Fetch all objects from a given bucket.

GET /bucket_registrations/{bucket_id}/objects
(watsonxData *WatsonxDataV2) ListBucketObjects(listBucketObjectsOptions *ListBucketObjectsOptions) (result *BucketRegistrationObjectCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListBucketObjectsWithContext(ctx context.Context, listBucketObjectsOptions *ListBucketObjectsOptions) (result *BucketRegistrationObjectCollection, response *core.DetailedResponse, err error)
ServiceCall<BucketRegistrationObjectCollection> listBucketObjects(ListBucketObjectsOptions listBucketObjectsOptions)
list_bucket_objects(
        self,
        bucket_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        path: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listBucketObjects(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.bucket_registration_object.list

Get bucket object properties

Get bucket object properties

Get bucket object properties.

Get bucket object properties.

Get bucket object properties.

Get bucket object properties.

POST /bucket_registrations/{bucket_id}/object_properties
(watsonxData *WatsonxDataV2) GetBucketObjectProperties(getBucketObjectPropertiesOptions *GetBucketObjectPropertiesOptions) (result *BucketObjectProperties, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetBucketObjectPropertiesWithContext(ctx context.Context, getBucketObjectPropertiesOptions *GetBucketObjectPropertiesOptions) (result *BucketObjectProperties, response *core.DetailedResponse, err error)
ServiceCall<BucketObjectProperties> getBucketObjectProperties(GetBucketObjectPropertiesOptions getBucketObjectPropertiesOptions)
get_bucket_object_properties(
        self,
        bucket_id: str,
        *,
        paths: Optional[List['Path']] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getBucketObjectProperties(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.bucket.object.properties

Add/Create HDFS storage

Add or create a new HDFS database

Add or create a new HDFS database.

Add or create a new HDFS database.

Add or create a new HDFS database.

Add or create a new HDFS database.

POST /storage_hdfs_registrations
(watsonxData *WatsonxDataV2) CreateHdfsStorage(createHdfsStorageOptions *CreateHdfsStorageOptions) (result *HdfsStorageRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateHdfsStorageWithContext(ctx context.Context, createHdfsStorageOptions *CreateHdfsStorageOptions) (result *HdfsStorageRegistration, response *core.DetailedResponse, err error)
ServiceCall<HdfsStorageRegistration> createHdfsStorage(CreateHdfsStorageOptions createHdfsStorageOptions)
create_hdfs_storage(
        self,
        bucket_display_name: str,
        bucket_type: str,
        hms_thrift_uri: str,
        hms_thrift_port: int,
        core_site: str,
        hdfs_site: str,
        kerberos: str,
        catalog_name: str,
        catalog_type: str,
        *,
        krb5_config: Optional[str] = None,
        hive_keytab: Optional[BinaryIO] = None,
        hive_keytab_content_type: Optional[str] = None,
        hdfs_keytab: Optional[BinaryIO] = None,
        hdfs_keytab_content_type: Optional[str] = None,
        hive_server_principal: Optional[str] = None,
        hive_client_principal: Optional[str] = None,
        hdfs_principal: Optional[str] = None,
        description: Optional[str] = None,
        created_on: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createHdfsStorage(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.storage_hdfs_registration.create

Get databases

Get list of databases

Get list of databases.

Get list of databases.

Get list of databases.

Get list of databases.

GET /database_registrations
(watsonxData *WatsonxDataV2) ListDatabaseRegistrations(listDatabaseRegistrationsOptions *ListDatabaseRegistrationsOptions) (result *DatabaseRegistrationCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListDatabaseRegistrationsWithContext(ctx context.Context, listDatabaseRegistrationsOptions *ListDatabaseRegistrationsOptions) (result *DatabaseRegistrationCollection, response *core.DetailedResponse, err error)
ServiceCall<DatabaseRegistrationCollection> listDatabaseRegistrations(ListDatabaseRegistrationsOptions listDatabaseRegistrationsOptions)
list_database_registrations(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listDatabaseRegistrations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.database_registration.list

Add/Create database

Add or create a new database

Add or create a new database.

Add or create a new database.

Add or create a new database.

Add or create a new database.

POST /database_registrations
(watsonxData *WatsonxDataV2) CreateDatabaseRegistration(createDatabaseRegistrationOptions *CreateDatabaseRegistrationOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateDatabaseRegistrationWithContext(ctx context.Context, createDatabaseRegistrationOptions *CreateDatabaseRegistrationOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
ServiceCall<DatabaseRegistration> createDatabaseRegistration(CreateDatabaseRegistrationOptions createDatabaseRegistrationOptions)
create_database_registration(
        self,
        database_display_name: str,
        database_type: str,
        *,
        associated_catalog: Optional['DatabaseCatalog'] = None,
        created_on: Optional[str] = None,
        database_details: Optional['DatabaseDetails'] = None,
        database_properties: Optional[List['DatabaseRegistrationPrototypeDatabasePropertiesItems']] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createDatabaseRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.database_registration.create

Get database

Get a registered databases

Get a registered databases.

Get a registered databases.

Get a registered databases.

Get a registered databases.

GET /database_registrations/{database_id}
(watsonxData *WatsonxDataV2) GetDatabase(getDatabaseOptions *GetDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetDatabaseWithContext(ctx context.Context, getDatabaseOptions *GetDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
ServiceCall<DatabaseRegistration> getDatabase(GetDatabaseOptions getDatabaseOptions)
get_database(
        self,
        database_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getDatabase(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete database

Delete a database

Delete a database.

Delete a database.

Delete a database.

Delete a database.

DELETE /database_registrations/{database_id}
(watsonxData *WatsonxDataV2) DeleteDatabaseCatalog(deleteDatabaseCatalogOptions *DeleteDatabaseCatalogOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteDatabaseCatalogWithContext(ctx context.Context, deleteDatabaseCatalogOptions *DeleteDatabaseCatalogOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteDatabaseCatalog(DeleteDatabaseCatalogOptions deleteDatabaseCatalogOptions)
delete_database_catalog(
        self,
        database_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteDatabaseCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update database

Update database details

Update database details.

Update database details.

Update database details.

Update database details.

PATCH /database_registrations/{database_id}
(watsonxData *WatsonxDataV2) UpdateDatabase(updateDatabaseOptions *UpdateDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateDatabaseWithContext(ctx context.Context, updateDatabaseOptions *UpdateDatabaseOptions) (result *DatabaseRegistration, response *core.DetailedResponse, err error)
ServiceCall<DatabaseRegistration> updateDatabase(UpdateDatabaseOptions updateDatabaseOptions)
update_database(
        self,
        database_id: str,
        body: 'DatabaseRegistrationPatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateDatabase(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get drivers

Get all driver details

Get all driver details.

Get all driver details.

Get all driver details.

Get all driver details.

GET /driver_registrations
(watsonxData *WatsonxDataV2) ListDriverRegistration(listDriverRegistrationOptions *ListDriverRegistrationOptions) (result *DriverRegistrationCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListDriverRegistrationWithContext(ctx context.Context, listDriverRegistrationOptions *ListDriverRegistrationOptions) (result *DriverRegistrationCollection, response *core.DetailedResponse, err error)
ServiceCall<DriverRegistrationCollection> listDriverRegistration(ListDriverRegistrationOptions listDriverRegistrationOptions)
list_driver_registration(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listDriverRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.driver_registration.list

Register driver

Register a new driver

Register a new driver.

Register a new driver.

Register a new driver.

Register a new driver.

POST /driver_registrations
(watsonxData *WatsonxDataV2) CreateDriverRegistration(createDriverRegistrationOptions *CreateDriverRegistrationOptions) (result *DriverRegistration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateDriverRegistrationWithContext(ctx context.Context, createDriverRegistrationOptions *CreateDriverRegistrationOptions) (result *DriverRegistration, response *core.DetailedResponse, err error)
ServiceCall<DriverRegistration> createDriverRegistration(CreateDriverRegistrationOptions createDriverRegistrationOptions)
create_driver_registration(
        self,
        driver: BinaryIO,
        driver_name: str,
        connection_type: str,
        *,
        driver_content_type: Optional[str] = None,
        version: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createDriverRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.driver_registration.create

Delete driver

Delete a driver

Delete a driver.

Delete a driver.

Delete a driver.

Delete a driver.

DELETE /driver_registrations/{driver_id}
(watsonxData *WatsonxDataV2) DeleteDriverRegistration(deleteDriverRegistrationOptions *DeleteDriverRegistrationOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteDriverRegistrationWithContext(ctx context.Context, deleteDriverRegistrationOptions *DeleteDriverRegistrationOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteDriverRegistration(DeleteDriverRegistrationOptions deleteDriverRegistrationOptions)
delete_driver_registration(
        self,
        driver_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteDriverRegistration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.driver_registration.delete

Disassociate engines from driver

Disassociate one or more engines from a driver

Disassociate one or more engines from a driver.

Disassociate one or more engines from a driver.

Disassociate one or more engines from a driver.

Disassociate one or more engines from a driver.

DELETE /driver_registrations/{driver_id}/engines
(watsonxData *WatsonxDataV2) DeleteDriverEngines(deleteDriverEnginesOptions *DeleteDriverEnginesOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteDriverEnginesWithContext(ctx context.Context, deleteDriverEnginesOptions *DeleteDriverEnginesOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteDriverEngines(DeleteDriverEnginesOptions deleteDriverEnginesOptions)
delete_driver_engines(
        self,
        driver_id: str,
        engine_ids: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteDriverEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.driver_registration_engine.remove

Associate engines to driver

Associate one or more engines to a driver

Associate one or more engines to a driver.

Associate one or more engines to a driver.

Associate one or more engines to a driver.

Associate one or more engines to a driver.

PATCH /driver_registrations/{driver_id}/engines
(watsonxData *WatsonxDataV2) UpdateDriverEngines(updateDriverEnginesOptions *UpdateDriverEnginesOptions) (result *DriverRegistrationEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateDriverEnginesWithContext(ctx context.Context, updateDriverEnginesOptions *UpdateDriverEnginesOptions) (result *DriverRegistrationEngine, response *core.DetailedResponse, err error)
ServiceCall<DriverRegistrationEngine> updateDriverEngines(UpdateDriverEnginesOptions updateDriverEnginesOptions)
update_driver_engines(
        self,
        driver_id: str,
        body: 'DriverRegistrationEnginePrototype',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateDriverEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.driver_registration_engine.add

List other engines

list all other engine details

list all other engine details.

list all other engine details.

list all other engine details.

list all other engine details.

GET /other_engines
(watsonxData *WatsonxDataV2) ListOtherEngines(listOtherEnginesOptions *ListOtherEnginesOptions) (result *OtherEngineCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListOtherEnginesWithContext(ctx context.Context, listOtherEnginesOptions *ListOtherEnginesOptions) (result *OtherEngineCollection, response *core.DetailedResponse, err error)
ServiceCall<OtherEngineCollection> listOtherEngines(ListOtherEnginesOptions listOtherEnginesOptions)
list_other_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listOtherEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Create other engine

Create a new engine

Create a new engine.

Create a new engine.

Create a new engine.

Create a new engine.

POST /other_engines
(watsonxData *WatsonxDataV2) CreateOtherEngine(createOtherEngineOptions *CreateOtherEngineOptions) (result *OtherEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateOtherEngineWithContext(ctx context.Context, createOtherEngineOptions *CreateOtherEngineOptions) (result *OtherEngine, response *core.DetailedResponse, err error)
ServiceCall<OtherEngine> createOtherEngine(CreateOtherEngineOptions createOtherEngineOptions)
create_other_engine(
        self,
        engine_details: 'OtherEngineDetailsBody',
        engine_display_name: str,
        *,
        description: Optional[str] = None,
        origin: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createOtherEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete engine

Delete an engine from lakehouse

Delete an engine from lakehouse.

Delete an engine from lakehouse.

Delete an engine from lakehouse.

Delete an engine from lakehouse.

DELETE /other_engines/{engine_id}
(watsonxData *WatsonxDataV2) DeleteOtherEngine(deleteOtherEngineOptions *DeleteOtherEngineOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteOtherEngineWithContext(ctx context.Context, deleteOtherEngineOptions *DeleteOtherEngineOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteOtherEngine(DeleteOtherEngineOptions deleteOtherEngineOptions)
delete_other_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteOtherEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get all existing Integrations

Get all existing Integrations

Get all existing Integrations.

Get all existing Integrations.

Get all existing Integrations.

Get all existing Integrations.

GET /integrations
(watsonxData *WatsonxDataV2) ListAllIntegrations(listAllIntegrationsOptions *ListAllIntegrationsOptions) (result *IntegrationCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListAllIntegrationsWithContext(ctx context.Context, listAllIntegrationsOptions *ListAllIntegrationsOptions) (result *IntegrationCollection, response *core.DetailedResponse, err error)
ServiceCall<IntegrationCollection> listAllIntegrations(ListAllIntegrationsOptions listAllIntegrationsOptions)
list_all_integrations(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        secret: Optional[str] = None,
        service_type: Optional[str] = None,
        state: Optional[List[str]] = None,
        **kwargs,
    ) -> DetailedResponse
listAllIntegrations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.integration.listall

To register an integration

To register an integration

To register an integration.

To register an integration.

To register an integration.

To register an integration.

POST /integrations
(watsonxData *WatsonxDataV2) CreateIntegration(createIntegrationOptions *CreateIntegrationOptions) (result *Integration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateIntegrationWithContext(ctx context.Context, createIntegrationOptions *CreateIntegrationOptions) (result *Integration, response *core.DetailedResponse, err error)
ServiceCall<Integration> createIntegration(CreateIntegrationOptions createIntegrationOptions)
create_integration(
        self,
        *,
        access_token: Optional[str] = None,
        apikey: Optional[str] = None,
        cross_account_integration: Optional[bool] = None,
        enable_data_policy_within_wxd: Optional[bool] = None,
        ikc_user_account_id: Optional[str] = None,
        password: Optional[str] = None,
        resource: Optional[str] = None,
        service_type: Optional[str] = None,
        storage_catalogs: Optional[List[str]] = None,
        url: Optional[str] = None,
        username: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createIntegration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.integration.create

Get an Integration

Get an Integration

Get an Integration.

Get an Integration.

Get an Integration.

Get an Integration.

GET /integrations/{integration_id}
(watsonxData *WatsonxDataV2) GetIntegrations(getIntegrationsOptions *GetIntegrationsOptions) (result *Integration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetIntegrationsWithContext(ctx context.Context, getIntegrationsOptions *GetIntegrationsOptions) (result *Integration, response *core.DetailedResponse, err error)
ServiceCall<Integration> getIntegrations(GetIntegrationsOptions getIntegrationsOptions)
get_integrations(
        self,
        integration_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        secret: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getIntegrations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.integration.get

Remove an Integration

Remove an Integration

Remove an Integration.

Remove an Integration.

Remove an Integration.

Remove an Integration.

DELETE /integrations/{integration_id}
(watsonxData *WatsonxDataV2) DeleteIntegration(deleteIntegrationOptions *DeleteIntegrationOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteIntegrationWithContext(ctx context.Context, deleteIntegrationOptions *DeleteIntegrationOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteIntegration(DeleteIntegrationOptions deleteIntegrationOptions)
delete_integration(
        self,
        integration_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteIntegration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.integration.delete

Update an existing Integration

Update an existing Integration

Update an existing Integration.

Update an existing Integration.

Update an existing Integration.

Update an existing Integration.

PATCH /integrations/{integration_id}
(watsonxData *WatsonxDataV2) UpdateIntegration(updateIntegrationOptions *UpdateIntegrationOptions) (result *Integration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateIntegrationWithContext(ctx context.Context, updateIntegrationOptions *UpdateIntegrationOptions) (result *Integration, response *core.DetailedResponse, err error)
ServiceCall<Integration> updateIntegration(UpdateIntegrationOptions updateIntegrationOptions)
update_integration(
        self,
        integration_id: str,
        integration_patch: 'IntegrationPatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateIntegration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.integration.update

Get list of db2 engines

Get list of all db2 engines

Get list of all db2 engines.

Get list of all db2 engines.

Get list of all db2 engines.

Get list of all db2 engines.

GET /db2_engines
(watsonxData *WatsonxDataV2) ListDb2Engines(listDb2EnginesOptions *ListDb2EnginesOptions) (result *Db2EngineCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListDb2EnginesWithContext(ctx context.Context, listDb2EnginesOptions *ListDb2EnginesOptions) (result *Db2EngineCollection, response *core.DetailedResponse, err error)
ServiceCall<Db2EngineCollection> listDb2Engines(ListDb2EnginesOptions listDb2EnginesOptions)
list_db2_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listDb2Engines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Create db2 engine

Create a new db2 engine

Create a new db2 engine.

Create a new db2 engine.

Create a new db2 engine.

Create a new db2 engine.

POST /db2_engines
(watsonxData *WatsonxDataV2) CreateDb2Engine(createDb2EngineOptions *CreateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateDb2EngineWithContext(ctx context.Context, createDb2EngineOptions *CreateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)
ServiceCall<Db2Engine> createDb2Engine(CreateDb2EngineOptions createDb2EngineOptions)
create_db2_engine(
        self,
        origin: str,
        *,
        description: Optional[str] = None,
        engine_details: Optional['Db2EngineDetailsBody'] = None,
        engine_display_name: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createDb2Engine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete db2 engine

Delete a db2 engine

Delete a db2 engine.

Delete a db2 engine.

Delete a db2 engine.

Delete a db2 engine.

DELETE /db2_engines/{engine_id}
(watsonxData *WatsonxDataV2) DeleteDb2Engine(deleteDb2EngineOptions *DeleteDb2EngineOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteDb2EngineWithContext(ctx context.Context, deleteDb2EngineOptions *DeleteDb2EngineOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteDb2Engine(DeleteDb2EngineOptions deleteDb2EngineOptions)
delete_db2_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteDb2Engine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update db2 engine

Update details of db2 engine

Update details of db2 engine.

Update details of db2 engine.

Update details of db2 engine.

Update details of db2 engine.

PATCH /db2_engines/{engine_id}
(watsonxData *WatsonxDataV2) UpdateDb2Engine(updateDb2EngineOptions *UpdateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateDb2EngineWithContext(ctx context.Context, updateDb2EngineOptions *UpdateDb2EngineOptions) (result *Db2Engine, response *core.DetailedResponse, err error)
ServiceCall<Db2Engine> updateDb2Engine(UpdateDb2EngineOptions updateDb2EngineOptions)
update_db2_engine(
        self,
        engine_id: str,
        body: 'Db2EnginePatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateDb2Engine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get list of netezza engines

Get list of all netezza engines

Get list of all netezza engines.

Get list of all netezza engines.

Get list of all netezza engines.

Get list of all netezza engines.

GET /netezza_engines
(watsonxData *WatsonxDataV2) ListNetezzaEngines(listNetezzaEnginesOptions *ListNetezzaEnginesOptions) (result *NetezzaEngineCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListNetezzaEnginesWithContext(ctx context.Context, listNetezzaEnginesOptions *ListNetezzaEnginesOptions) (result *NetezzaEngineCollection, response *core.DetailedResponse, err error)
ServiceCall<NetezzaEngineCollection> listNetezzaEngines(ListNetezzaEnginesOptions listNetezzaEnginesOptions)
list_netezza_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listNetezzaEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Create netezza engine

Create a new netezza engine

Create a new netezza engine.

Create a new netezza engine.

Create a new netezza engine.

Create a new netezza engine.

POST /netezza_engines
(watsonxData *WatsonxDataV2) CreateNetezzaEngine(createNetezzaEngineOptions *CreateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateNetezzaEngineWithContext(ctx context.Context, createNetezzaEngineOptions *CreateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)
ServiceCall<NetezzaEngine> createNetezzaEngine(CreateNetezzaEngineOptions createNetezzaEngineOptions)
create_netezza_engine(
        self,
        origin: str,
        *,
        description: Optional[str] = None,
        engine_details: Optional['NetezzaEngineDetailsBody'] = None,
        engine_display_name: Optional[str] = None,
        tags: Optional[List[str]] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createNetezzaEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete netezza engine

Delete a netezza engine

Delete a netezza engine.

Delete a netezza engine.

Delete a netezza engine.

Delete a netezza engine.

DELETE /netezza_engines/{engine_id}
(watsonxData *WatsonxDataV2) DeleteNetezzaEngine(deleteNetezzaEngineOptions *DeleteNetezzaEngineOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteNetezzaEngineWithContext(ctx context.Context, deleteNetezzaEngineOptions *DeleteNetezzaEngineOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteNetezzaEngine(DeleteNetezzaEngineOptions deleteNetezzaEngineOptions)
delete_netezza_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteNetezzaEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update netezza engine

Update details of netezza engine

Update details of netezza engine.

Update details of netezza engine.

Update details of netezza engine.

Update details of netezza engine.

PATCH /netezza_engines/{engine_id}
(watsonxData *WatsonxDataV2) UpdateNetezzaEngine(updateNetezzaEngineOptions *UpdateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateNetezzaEngineWithContext(ctx context.Context, updateNetezzaEngineOptions *UpdateNetezzaEngineOptions) (result *NetezzaEngine, response *core.DetailedResponse, err error)
ServiceCall<NetezzaEngine> updateNetezzaEngine(UpdateNetezzaEngineOptions updateNetezzaEngineOptions)
update_netezza_engine(
        self,
        engine_id: str,
        body: 'NetezzaEnginePatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateNetezzaEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get all instance details

Get all engine details

Get all engine details.

Get all engine details.

Get all engine details.

Get all engine details.

GET /instance_details
(watsonxData *WatsonxDataV2) ListInstanceDetails(listInstanceDetailsOptions *ListInstanceDetailsOptions) (result *WatsonxInstanceDetailsCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListInstanceDetailsWithContext(ctx context.Context, listInstanceDetailsOptions *ListInstanceDetailsOptions) (result *WatsonxInstanceDetailsCollection, response *core.DetailedResponse, err error)
ServiceCall<WatsonxInstanceDetailsCollection> listInstanceDetails(ListInstanceDetailsOptions listInstanceDetailsOptions)
list_instance_details(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listInstanceDetails(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.instance_detail.list

Get engines and services detail

Get engines and services detail

Get engines and services detail.

Get engines and services detail.

Get engines and services detail.

Get engines and services detail.

GET /instance_details/engines_services
(watsonxData *WatsonxDataV2) ListInstanceServiceDetails(listInstanceServiceDetailsOptions *ListInstanceServiceDetailsOptions) (result *EnginesServicesDetails, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListInstanceServiceDetailsWithContext(ctx context.Context, listInstanceServiceDetailsOptions *ListInstanceServiceDetailsOptions) (result *EnginesServicesDetails, response *core.DetailedResponse, err error)
ServiceCall<EnginesServicesDetails> listInstanceServiceDetails(ListInstanceServiceDetailsOptions listInstanceServiceDetailsOptions)
list_instance_service_details(
        self,
        target: str,
        *,
        internal_host: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listInstanceServiceDetails(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.instance__service_details.list

Get services details

Get services details for a given engine or service type.

Get services details for a given engine or service type.

Get services details for a given engine or service type.

Get services details for a given engine or service type.

Get services details for a given engine or service type.

GET /instance_details/engines_services/{engine_or_service_type}
(watsonxData *WatsonxDataV2) GetServicesDetails(getServicesDetailsOptions *GetServicesDetailsOptions) (result *ServicesDetails, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetServicesDetailsWithContext(ctx context.Context, getServicesDetailsOptions *GetServicesDetailsOptions) (result *ServicesDetails, response *core.DetailedResponse, err error)
ServiceCall<ServicesDetails> getServicesDetails(GetServicesDetailsOptions getServicesDetailsOptions)
get_services_details(
        self,
        target: str,
        engine_or_service_type: str,
        *,
        internal_host: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getServicesDetails(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.instance_detail.get

Get Milvus service detail

Get Milvus service detail

Get Milvus service detail.

Get Milvus service detail.

Get Milvus service detail.

Get Milvus service detail.

GET /instance_details/engines_services/{engine_or_service_type}/id/{id}
(watsonxData *WatsonxDataV2) GetServiceDetail(getServiceDetailOptions *GetServiceDetailOptions) (result *ConnectionPropertiesDetails, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetServiceDetailWithContext(ctx context.Context, getServiceDetailOptions *GetServiceDetailOptions) (result *ConnectionPropertiesDetails, response *core.DetailedResponse, err error)
ServiceCall<ConnectionPropertiesDetails> getServiceDetail(GetServiceDetailOptions getServiceDetailOptions)
get_service_detail(
        self,
        target: str,
        engine_or_service_type: str,
        id: str,
        *,
        database: Optional[str] = None,
        internal_host: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getServiceDetail(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.instance_detail.get

Get list of prestissimo engines

Get list of all prestissimo engines

Get list of all prestissimo engines.

Get list of all prestissimo engines.

Get list of all prestissimo engines.

Get list of all prestissimo engines.

GET /prestissimo_engines
(watsonxData *WatsonxDataV2) ListPrestissimoEngines(listPrestissimoEnginesOptions *ListPrestissimoEnginesOptions) (result *PrestissimoEngineCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListPrestissimoEnginesWithContext(ctx context.Context, listPrestissimoEnginesOptions *ListPrestissimoEnginesOptions) (result *PrestissimoEngineCollection, response *core.DetailedResponse, err error)
ServiceCall<PrestissimoEngineCollection> listPrestissimoEngines(ListPrestissimoEnginesOptions listPrestissimoEnginesOptions)
list_prestissimo_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listPrestissimoEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Create prestissimo engine

Create a new prestissimo engine

Create a new prestissimo engine.

Create a new prestissimo engine.

Create a new prestissimo engine.

Create a new prestissimo engine.

POST /prestissimo_engines
(watsonxData *WatsonxDataV2) CreatePrestissimoEngine(createPrestissimoEngineOptions *CreatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreatePrestissimoEngineWithContext(ctx context.Context, createPrestissimoEngineOptions *CreatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)
ServiceCall<PrestissimoEngine> createPrestissimoEngine(CreatePrestissimoEngineOptions createPrestissimoEngineOptions)
create_prestissimo_engine(
        self,
        origin: str,
        *,
        associated_catalogs: Optional[List[str]] = None,
        description: Optional[str] = None,
        engine_details: Optional['PrestissimoEngineDetails'] = None,
        engine_display_name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[List[str]] = None,
        version: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createPrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get prestissimo engine

Get details of one prestissimo engine

Get details of one prestissimo engine.

Get details of one prestissimo engine.

Get details of one prestissimo engine.

Get details of one prestissimo engine.

GET /prestissimo_engines/{engine_id}
(watsonxData *WatsonxDataV2) GetPrestissimoEngine(getPrestissimoEngineOptions *GetPrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetPrestissimoEngineWithContext(ctx context.Context, getPrestissimoEngineOptions *GetPrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)
ServiceCall<PrestissimoEngine> getPrestissimoEngine(GetPrestissimoEngineOptions getPrestissimoEngineOptions)
get_prestissimo_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getPrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete prestissimo engine

Delete a prestissimo engine

Delete a prestissimo engine.

Delete a prestissimo engine.

Delete a prestissimo engine.

Delete a prestissimo engine.

DELETE /prestissimo_engines/{engine_id}
(watsonxData *WatsonxDataV2) DeletePrestissimoEngine(deletePrestissimoEngineOptions *DeletePrestissimoEngineOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeletePrestissimoEngineWithContext(ctx context.Context, deletePrestissimoEngineOptions *DeletePrestissimoEngineOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deletePrestissimoEngine(DeletePrestissimoEngineOptions deletePrestissimoEngineOptions)
delete_prestissimo_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deletePrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update prestissimo engine

Update details of prestissimo engine

Update details of prestissimo engine.

Update details of prestissimo engine.

Update details of prestissimo engine.

Update details of prestissimo engine.

PATCH /prestissimo_engines/{engine_id}
(watsonxData *WatsonxDataV2) UpdatePrestissimoEngine(updatePrestissimoEngineOptions *UpdatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdatePrestissimoEngineWithContext(ctx context.Context, updatePrestissimoEngineOptions *UpdatePrestissimoEngineOptions) (result *PrestissimoEngine, response *core.DetailedResponse, err error)
ServiceCall<PrestissimoEngine> updatePrestissimoEngine(UpdatePrestissimoEngineOptions updatePrestissimoEngineOptions)
update_prestissimo_engine(
        self,
        engine_id: str,
        body: 'PrestissimoEnginePatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updatePrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get prestissimo engine catalogs

Get list of all catalogs attached a prestissimo engine

Get list of all catalogs attached a prestissimo engine.

Get list of all catalogs attached a prestissimo engine.

Get list of all catalogs attached a prestissimo engine.

Get list of all catalogs attached a prestissimo engine.

GET /prestissimo_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) ListPrestissimoEngineCatalogs(listPrestissimoEngineCatalogsOptions *ListPrestissimoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListPrestissimoEngineCatalogsWithContext(ctx context.Context, listPrestissimoEngineCatalogsOptions *ListPrestissimoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
ServiceCall<CatalogCollection> listPrestissimoEngineCatalogs(ListPrestissimoEngineCatalogsOptions listPrestissimoEngineCatalogsOptions)
list_prestissimo_engine_catalogs(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listPrestissimoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Associate catalogs to a prestissimo engine

Associate one or more catalogs to a prestissimo engine

Associate one or more catalogs to a prestissimo engine.

Associate one or more catalogs to a prestissimo engine.

Associate one or more catalogs to a prestissimo engine.

Associate one or more catalogs to a prestissimo engine.

POST /prestissimo_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) CreatePrestissimoEngineCatalogs(createPrestissimoEngineCatalogsOptions *CreatePrestissimoEngineCatalogsOptions) (result *Catalog, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreatePrestissimoEngineCatalogsWithContext(ctx context.Context, createPrestissimoEngineCatalogsOptions *CreatePrestissimoEngineCatalogsOptions) (result *Catalog, response *core.DetailedResponse, err error)
ServiceCall<Catalog> createPrestissimoEngineCatalogs(CreatePrestissimoEngineCatalogsOptions createPrestissimoEngineCatalogsOptions)
create_prestissimo_engine_catalogs(
        self,
        engine_id: str,
        *,
        catalog_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createPrestissimoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Disassociate catalogs from a prestissimo engine

Disassociate one or more catalogs from a prestissimo engine

Disassociate one or more catalogs from a prestissimo engine.

Disassociate one or more catalogs from a prestissimo engine.

Disassociate one or more catalogs from a prestissimo engine.

Disassociate one or more catalogs from a prestissimo engine.

DELETE /prestissimo_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) DeletePrestissimoEngineCatalogs(deletePrestissimoEngineCatalogsOptions *DeletePrestissimoEngineCatalogsOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeletePrestissimoEngineCatalogsWithContext(ctx context.Context, deletePrestissimoEngineCatalogsOptions *DeletePrestissimoEngineCatalogsOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deletePrestissimoEngineCatalogs(DeletePrestissimoEngineCatalogsOptions deletePrestissimoEngineCatalogsOptions)
delete_prestissimo_engine_catalogs(
        self,
        engine_id: str,
        catalog_names: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deletePrestissimoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get prestissimo engine catalog

Get catalog attached to a prestissimo engine

Get catalog attached to a prestissimo engine.

Get catalog attached to a prestissimo engine.

Get catalog attached to a prestissimo engine.

Get catalog attached to a prestissimo engine.

GET /prestissimo_engines/{engine_id}/catalogs/{catalog_id}
(watsonxData *WatsonxDataV2) GetPrestissimoEngineCatalog(getPrestissimoEngineCatalogOptions *GetPrestissimoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetPrestissimoEngineCatalogWithContext(ctx context.Context, getPrestissimoEngineCatalogOptions *GetPrestissimoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
ServiceCall<Catalog> getPrestissimoEngineCatalog(GetPrestissimoEngineCatalogOptions getPrestissimoEngineCatalogOptions)
get_prestissimo_engine_catalog(
        self,
        engine_id: str,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getPrestissimoEngineCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Pause prestissimo engine

Pause a running prestissimo engine

Pause a running prestissimo engine.

Pause a running prestissimo engine.

Pause a running prestissimo engine.

Pause a running prestissimo engine.

POST /prestissimo_engines/{engine_id}/pause
(watsonxData *WatsonxDataV2) PausePrestissimoEngine(pausePrestissimoEngineOptions *PausePrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) PausePrestissimoEngineWithContext(ctx context.Context, pausePrestissimoEngineOptions *PausePrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> pausePrestissimoEngine(PausePrestissimoEngineOptions pausePrestissimoEngineOptions)
pause_prestissimo_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
pausePrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Explain query

Explain a query statement

Explain a query statement.

Explain a query statement.

Explain a query statement.

Explain a query statement.

POST /prestissimo_engines/{engine_id}/query_explain
(watsonxData *WatsonxDataV2) RunPrestissimoExplainStatement(runPrestissimoExplainStatementOptions *RunPrestissimoExplainStatementOptions) (result *ResultPrestissimoExplainStatement, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RunPrestissimoExplainStatementWithContext(ctx context.Context, runPrestissimoExplainStatementOptions *RunPrestissimoExplainStatementOptions) (result *ResultPrestissimoExplainStatement, response *core.DetailedResponse, err error)
ServiceCall<ResultPrestissimoExplainStatement> runPrestissimoExplainStatement(RunPrestissimoExplainStatementOptions runPrestissimoExplainStatementOptions)
run_prestissimo_explain_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        format: Optional[str] = None,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
runPrestissimoExplainStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Explain analyze

Return query metrics after query is complete

Return query metrics after query is complete.

Return query metrics after query is complete.

Return query metrics after query is complete.

Return query metrics after query is complete.

POST /prestissimo_engines/{engine_id}/query_explain_analyze
(watsonxData *WatsonxDataV2) RunPrestissimoExplainAnalyzeStatement(runPrestissimoExplainAnalyzeStatementOptions *RunPrestissimoExplainAnalyzeStatementOptions) (result *ResultRunPrestissimoExplainAnalyzeStatement, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RunPrestissimoExplainAnalyzeStatementWithContext(ctx context.Context, runPrestissimoExplainAnalyzeStatementOptions *RunPrestissimoExplainAnalyzeStatementOptions) (result *ResultRunPrestissimoExplainAnalyzeStatement, response *core.DetailedResponse, err error)
ServiceCall<ResultRunPrestissimoExplainAnalyzeStatement> runPrestissimoExplainAnalyzeStatement(RunPrestissimoExplainAnalyzeStatementOptions runPrestissimoExplainAnalyzeStatementOptions)
run_prestissimo_explain_analyze_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        verbose: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
runPrestissimoExplainAnalyzeStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Restart a prestissimo engine

Restart an existing prestissimo engine

Restart an existing prestissimo engine.

Restart an existing prestissimo engine.

Restart an existing prestissimo engine.

Restart an existing prestissimo engine.

POST /prestissimo_engines/{engine_id}/restart
(watsonxData *WatsonxDataV2) RestartPrestissimoEngine(restartPrestissimoEngineOptions *RestartPrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RestartPrestissimoEngineWithContext(ctx context.Context, restartPrestissimoEngineOptions *RestartPrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> restartPrestissimoEngine(RestartPrestissimoEngineOptions restartPrestissimoEngineOptions)
restart_prestissimo_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
restartPrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Resume prestissimo engine

Resume a paused prestissimo engine

Resume a paused prestissimo engine.

Resume a paused prestissimo engine.

Resume a paused prestissimo engine.

Resume a paused prestissimo engine.

POST /prestissimo_engines/{engine_id}/resume
(watsonxData *WatsonxDataV2) ResumePrestissimoEngine(resumePrestissimoEngineOptions *ResumePrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ResumePrestissimoEngineWithContext(ctx context.Context, resumePrestissimoEngineOptions *ResumePrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> resumePrestissimoEngine(ResumePrestissimoEngineOptions resumePrestissimoEngineOptions)
resume_prestissimo_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
resumePrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Scale a prestissimo engine

Scale an existing prestissimo engine

Scale an existing prestissimo engine.

Scale an existing prestissimo engine.

Scale an existing prestissimo engine.

Scale an existing prestissimo engine.

POST /prestissimo_engines/{engine_id}/scale
(watsonxData *WatsonxDataV2) ScalePrestissimoEngine(scalePrestissimoEngineOptions *ScalePrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ScalePrestissimoEngineWithContext(ctx context.Context, scalePrestissimoEngineOptions *ScalePrestissimoEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> scalePrestissimoEngine(ScalePrestissimoEngineOptions scalePrestissimoEngineOptions)
scale_prestissimo_engine(
        self,
        engine_id: str,
        *,
        coordinator: Optional['PrestissimoNodeDescriptionBody'] = None,
        worker: Optional['PrestissimoNodeDescriptionBody'] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
scalePrestissimoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get list of presto engines

Get list of all presto engines

Get list of all presto engines.

Get list of all presto engines.

Get list of all presto engines.

Get list of all presto engines.

GET /presto_engines
(watsonxData *WatsonxDataV2) ListPrestoEngines(listPrestoEnginesOptions *ListPrestoEnginesOptions) (result *PrestoEngineCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListPrestoEnginesWithContext(ctx context.Context, listPrestoEnginesOptions *ListPrestoEnginesOptions) (result *PrestoEngineCollection, response *core.DetailedResponse, err error)
ServiceCall<PrestoEngineCollection> listPrestoEngines(ListPrestoEnginesOptions listPrestoEnginesOptions)
list_presto_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listPrestoEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Create presto engine

Create a new presto engine

Create a new presto engine.

Create a new presto engine.

Create a new presto engine.

Create a new presto engine.

POST /presto_engines
(watsonxData *WatsonxDataV2) CreatePrestoEngine(createPrestoEngineOptions *CreatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreatePrestoEngineWithContext(ctx context.Context, createPrestoEngineOptions *CreatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)
ServiceCall<PrestoEngine> createPrestoEngine(CreatePrestoEngineOptions createPrestoEngineOptions)
create_presto_engine(
        self,
        origin: str,
        *,
        associated_catalogs: Optional[List[str]] = None,
        description: Optional[str] = None,
        engine_details: Optional['EngineDetailsBody'] = None,
        engine_display_name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[List[str]] = None,
        version: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createPrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get presto engine

Get details of one presto engine

Get details of one presto engine.

Get details of one presto engine.

Get details of one presto engine.

Get details of one presto engine.

GET /presto_engines/{engine_id}
(watsonxData *WatsonxDataV2) GetPrestoEngine(getPrestoEngineOptions *GetPrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetPrestoEngineWithContext(ctx context.Context, getPrestoEngineOptions *GetPrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)
ServiceCall<PrestoEngine> getPrestoEngine(GetPrestoEngineOptions getPrestoEngineOptions)
get_presto_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getPrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete presto engine

Delete a presto engine

Delete a presto engine.

Delete a presto engine.

Delete a presto engine.

Delete a presto engine.

DELETE /presto_engines/{engine_id}
(watsonxData *WatsonxDataV2) DeleteEngine(deleteEngineOptions *DeleteEngineOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteEngineWithContext(ctx context.Context, deleteEngineOptions *DeleteEngineOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteEngine(DeleteEngineOptions deleteEngineOptions)
delete_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update presto engine

Update details of presto engine

Update details of presto engine.

Update details of presto engine.

Update details of presto engine.

Update details of presto engine.

PATCH /presto_engines/{engine_id}
(watsonxData *WatsonxDataV2) UpdatePrestoEngine(updatePrestoEngineOptions *UpdatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdatePrestoEngineWithContext(ctx context.Context, updatePrestoEngineOptions *UpdatePrestoEngineOptions) (result *PrestoEngine, response *core.DetailedResponse, err error)
ServiceCall<PrestoEngine> updatePrestoEngine(UpdatePrestoEngineOptions updatePrestoEngineOptions)
update_presto_engine(
        self,
        engine_id: str,
        body: 'PrestoEnginePatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updatePrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get presto engine catalogs

Get list of all catalogs attached to a presto engine

Get list of all catalogs attached to a presto engine.

Get list of all catalogs attached to a presto engine.

Get list of all catalogs attached to a presto engine.

Get list of all catalogs attached to a presto engine.

GET /presto_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) ListPrestoEngineCatalogs(listPrestoEngineCatalogsOptions *ListPrestoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListPrestoEngineCatalogsWithContext(ctx context.Context, listPrestoEngineCatalogsOptions *ListPrestoEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
ServiceCall<CatalogCollection> listPrestoEngineCatalogs(ListPrestoEngineCatalogsOptions listPrestoEngineCatalogsOptions)
list_presto_engine_catalogs(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listPrestoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Associate catalogs to presto engine

Associate one or more catalogs to a presto engine

Associate one or more catalogs to a presto engine.

Associate one or more catalogs to a presto engine.

Associate one or more catalogs to a presto engine.

Associate one or more catalogs to a presto engine.

POST /presto_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) CreatePrestoEngineCatalogs(createPrestoEngineCatalogsOptions *CreatePrestoEngineCatalogsOptions) (result *Catalog, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreatePrestoEngineCatalogsWithContext(ctx context.Context, createPrestoEngineCatalogsOptions *CreatePrestoEngineCatalogsOptions) (result *Catalog, response *core.DetailedResponse, err error)
ServiceCall<Catalog> createPrestoEngineCatalogs(CreatePrestoEngineCatalogsOptions createPrestoEngineCatalogsOptions)
create_presto_engine_catalogs(
        self,
        engine_id: str,
        *,
        catalog_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createPrestoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Disassociate catalogs from a presto engine

Disassociate one or more catalogs from a presto engine

Disassociate one or more catalogs from a presto engine.

Disassociate one or more catalogs from a presto engine.

Disassociate one or more catalogs from a presto engine.

Disassociate one or more catalogs from a presto engine.

DELETE /presto_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) DeletePrestoEngineCatalogs(deletePrestoEngineCatalogsOptions *DeletePrestoEngineCatalogsOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeletePrestoEngineCatalogsWithContext(ctx context.Context, deletePrestoEngineCatalogsOptions *DeletePrestoEngineCatalogsOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deletePrestoEngineCatalogs(DeletePrestoEngineCatalogsOptions deletePrestoEngineCatalogsOptions)
delete_presto_engine_catalogs(
        self,
        engine_id: str,
        catalog_names: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deletePrestoEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get presto engine catalog

Get catalog attached to presto engine

Get catalog attached to presto engine.

Get catalog attached to presto engine.

Get catalog attached to presto engine.

Get catalog attached to presto engine.

GET /presto_engines/{engine_id}/catalogs/{catalog_id}
(watsonxData *WatsonxDataV2) GetPrestoEngineCatalog(getPrestoEngineCatalogOptions *GetPrestoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetPrestoEngineCatalogWithContext(ctx context.Context, getPrestoEngineCatalogOptions *GetPrestoEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
ServiceCall<Catalog> getPrestoEngineCatalog(GetPrestoEngineCatalogOptions getPrestoEngineCatalogOptions)
get_presto_engine_catalog(
        self,
        engine_id: str,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getPrestoEngineCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Pause presto engine

Pause a running presto engine

Pause a running presto engine.

Pause a running presto engine.

Pause a running presto engine.

Pause a running presto engine.

POST /presto_engines/{engine_id}/pause
(watsonxData *WatsonxDataV2) PausePrestoEngine(pausePrestoEngineOptions *PausePrestoEngineOptions) (result *CreateEnginePauseCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) PausePrestoEngineWithContext(ctx context.Context, pausePrestoEngineOptions *PausePrestoEngineOptions) (result *CreateEnginePauseCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<CreateEnginePauseCreatedBody> pausePrestoEngine(PausePrestoEngineOptions pausePrestoEngineOptions)
pause_presto_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
pausePrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Explain presto query

Explain a query statement

Explain a query statement.

Explain a query statement.

Explain a query statement.

Explain a query statement.

POST /presto_engines/{engine_id}/query_explain
(watsonxData *WatsonxDataV2) RunExplainStatement(runExplainStatementOptions *RunExplainStatementOptions) (result *RunExplainStatementOKBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RunExplainStatementWithContext(ctx context.Context, runExplainStatementOptions *RunExplainStatementOptions) (result *RunExplainStatementOKBody, response *core.DetailedResponse, err error)
ServiceCall<RunExplainStatementOKBody> runExplainStatement(RunExplainStatementOptions runExplainStatementOptions)
run_explain_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        format: Optional[str] = None,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
runExplainStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Explain presto analyze

Return query metrics after query is complete

Return query metrics after query is complete.

Return query metrics after query is complete.

Return query metrics after query is complete.

Return query metrics after query is complete.

POST /presto_engines/{engine_id}/query_explain_analyze
(watsonxData *WatsonxDataV2) RunExplainAnalyzeStatement(runExplainAnalyzeStatementOptions *RunExplainAnalyzeStatementOptions) (result *RunExplainAnalyzeStatementOKBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RunExplainAnalyzeStatementWithContext(ctx context.Context, runExplainAnalyzeStatementOptions *RunExplainAnalyzeStatementOptions) (result *RunExplainAnalyzeStatementOKBody, response *core.DetailedResponse, err error)
ServiceCall<RunExplainAnalyzeStatementOKBody> runExplainAnalyzeStatement(RunExplainAnalyzeStatementOptions runExplainAnalyzeStatementOptions)
run_explain_analyze_statement(
        self,
        engine_id: str,
        statement: str,
        *,
        verbose: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
runExplainAnalyzeStatement(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Restart a presto engine

Restart an existing presto engine

Restart an existing presto engine.

Restart an existing presto engine.

Restart an existing presto engine.

Restart an existing presto engine.

POST /presto_engines/{engine_id}/restart
(watsonxData *WatsonxDataV2) RestartPrestoEngine(restartPrestoEngineOptions *RestartPrestoEngineOptions) (result *CreateEngineRestartCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RestartPrestoEngineWithContext(ctx context.Context, restartPrestoEngineOptions *RestartPrestoEngineOptions) (result *CreateEngineRestartCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<CreateEngineRestartCreatedBody> restartPrestoEngine(RestartPrestoEngineOptions restartPrestoEngineOptions)
restart_presto_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
restartPrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Resume presto engine

Resume a paused presto engine

Resume a paused presto engine.

Resume a paused presto engine.

Resume a paused presto engine.

Resume a paused presto engine.

POST /presto_engines/{engine_id}/resume
(watsonxData *WatsonxDataV2) ResumePrestoEngine(resumePrestoEngineOptions *ResumePrestoEngineOptions) (result *CreateEngineResumeCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ResumePrestoEngineWithContext(ctx context.Context, resumePrestoEngineOptions *ResumePrestoEngineOptions) (result *CreateEngineResumeCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<CreateEngineResumeCreatedBody> resumePrestoEngine(ResumePrestoEngineOptions resumePrestoEngineOptions)
resume_presto_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
resumePrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Scale a presto engine

Scale an existing presto engine

Scale an existing presto engine.

Scale an existing presto engine.

Scale an existing presto engine.

Scale an existing presto engine.

POST /presto_engines/{engine_id}/scale
(watsonxData *WatsonxDataV2) ScalePrestoEngine(scalePrestoEngineOptions *ScalePrestoEngineOptions) (result *CreateEngineScaleCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ScalePrestoEngineWithContext(ctx context.Context, scalePrestoEngineOptions *ScalePrestoEngineOptions) (result *CreateEngineScaleCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<CreateEngineScaleCreatedBody> scalePrestoEngine(ScalePrestoEngineOptions scalePrestoEngineOptions)
scale_presto_engine(
        self,
        engine_id: str,
        *,
        coordinator: Optional['NodeDescription'] = None,
        worker: Optional['NodeDescription'] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
scalePrestoEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get SAL Integrations

Get SAL Integration

Get SAL Integration.

Get SAL Integration.

Get SAL Integration.

Get SAL Integration.

GET /sal_integrations
(watsonxData *WatsonxDataV2) GetSalIntegration(getSalIntegrationOptions *GetSalIntegrationOptions) (result *SalIntegration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationWithContext(ctx context.Context, getSalIntegrationOptions *GetSalIntegrationOptions) (result *SalIntegration, response *core.DetailedResponse, err error)
ServiceCall<SalIntegration> getSalIntegration(GetSalIntegrationOptions getSalIntegrationOptions)
get_sal_integration(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration.get

Create sal integration with wxd

Add or create a new sal integration

Add or create a new sal integration.

Add or create a new sal integration.

Add or create a new sal integration.

Add or create a new sal integration.

POST /sal_integrations
(watsonxData *WatsonxDataV2) CreateSalIntegration(createSalIntegrationOptions *CreateSalIntegrationOptions) (result *SalIntegration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSalIntegrationWithContext(ctx context.Context, createSalIntegrationOptions *CreateSalIntegrationOptions) (result *SalIntegration, response *core.DetailedResponse, err error)
ServiceCall<SalIntegration> createSalIntegration(CreateSalIntegrationOptions createSalIntegrationOptions)
create_sal_integration(
        self,
        apikey: str,
        engine_id: str,
        *,
        storage_resource_crn: Optional[str] = None,
        storage_type: Optional[str] = None,
        trial_plan: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSalIntegration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration.create

Delete sal-wxd integration

Delete a sal-wxd integration

Delete a sal-wxd integration.

Delete a sal-wxd integration.

Delete a sal-wxd integration.

Delete a sal-wxd integration.

DELETE /sal_integrations
(watsonxData *WatsonxDataV2) DeleteSalIntegration(deleteSalIntegrationOptions *DeleteSalIntegrationOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteSalIntegrationWithContext(ctx context.Context, deleteSalIntegrationOptions *DeleteSalIntegrationOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteSalIntegration()
delete_sal_integration(
        self,
        **kwargs,
    ) -> DetailedResponse
deleteSalIntegration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration.delete

Update sal-wxd integration

Update sal-wxd integration details

Update sal-wxd integration details.

Update sal-wxd integration details.

Update sal-wxd integration details.

Update sal-wxd integration details.

PATCH /sal_integrations
(watsonxData *WatsonxDataV2) UpdateSalIntegration(updateSalIntegrationOptions *UpdateSalIntegrationOptions) (result *SalIntegration, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateSalIntegrationWithContext(ctx context.Context, updateSalIntegrationOptions *UpdateSalIntegrationOptions) (result *SalIntegration, response *core.DetailedResponse, err error)
ServiceCall<SalIntegration> updateSalIntegration(UpdateSalIntegrationOptions updateSalIntegrationOptions)
update_sal_integration(
        self,
        body: 'SalIntegrationPatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateSalIntegration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration.update

Trigger enrichment jobs on schemas and tables

Trigger enrichment jobs on schemas and tables

Trigger enrichment jobs on schemas and tables.

Trigger enrichment jobs on schemas and tables.

Trigger enrichment jobs on schemas and tables.

Trigger enrichment jobs on schemas and tables.

POST /sal_integrations/enrichment
(watsonxData *WatsonxDataV2) CreateSalIntegrationEnrichment(createSalIntegrationEnrichmentOptions *CreateSalIntegrationEnrichmentOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSalIntegrationEnrichmentWithContext(ctx context.Context, createSalIntegrationEnrichmentOptions *CreateSalIntegrationEnrichmentOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> createSalIntegrationEnrichment(CreateSalIntegrationEnrichmentOptions createSalIntegrationEnrichmentOptions)
create_sal_integration_enrichment(
        self,
        *,
        enrichment_prototype: Optional['EnrichmentObj'] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSalIntegrationEnrichment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_enrichment.create

Get semantic enrichment assets associated with the schema

Get semantic enrichment job runs associated with the schema

Get semantic enrichment job runs associated with the schema.

Get semantic enrichment job runs associated with the schema.

Get semantic enrichment job runs associated with the schema.

Get semantic enrichment job runs associated with the schema.

GET /sal_integrations/enrichment_assets
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentAssets(getSalIntegrationEnrichmentAssetsOptions *GetSalIntegrationEnrichmentAssetsOptions) (result *SalIntegrationEnrichmentAssets, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentAssetsWithContext(ctx context.Context, getSalIntegrationEnrichmentAssetsOptions *GetSalIntegrationEnrichmentAssetsOptions) (result *SalIntegrationEnrichmentAssets, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentAssets> getSalIntegrationEnrichmentAssets(GetSalIntegrationEnrichmentAssetsOptions getSalIntegrationEnrichmentAssetsOptions)
get_sal_integration_enrichment_assets(
        self,
        *,
        project_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationEnrichmentAssets(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_enrichment_assets.get

Get semantic enrichment data asset associated with the table

Get semantic enrichment data asset associated with the table

Get semantic enrichment data asset associated with the table.

Get semantic enrichment data asset associated with the table.

Get semantic enrichment data asset associated with the table.

Get semantic enrichment data asset associated with the table.

GET /sal_integrations/enrichment_data_asset
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentDataAsset(getSalIntegrationEnrichmentDataAssetOptions *GetSalIntegrationEnrichmentDataAssetOptions) (result *SalIntegrationEnrichmentDataAsset, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentDataAssetWithContext(ctx context.Context, getSalIntegrationEnrichmentDataAssetOptions *GetSalIntegrationEnrichmentDataAssetOptions) (result *SalIntegrationEnrichmentDataAsset, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentDataAsset> getSalIntegrationEnrichmentDataAsset(GetSalIntegrationEnrichmentDataAssetOptions getSalIntegrationEnrichmentDataAssetOptions)
get_sal_integration_enrichment_data_asset(
        self,
        *,
        project_id: Optional[str] = None,
        asset_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationEnrichmentDataAsset(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_enrichment_assets.get

Get semantic enrichment job run logs associated with the job run

Get semantic enrichment job run logs associated with the job run

Get semantic enrichment job run logs associated with the job run.

Get semantic enrichment job run logs associated with the job run.

Get semantic enrichment job run logs associated with the job run.

Get semantic enrichment job run logs associated with the job run.

GET /sal_integrations/enrichment_job_run_logs
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentJobRunLogs(getSalIntegrationEnrichmentJobRunLogsOptions *GetSalIntegrationEnrichmentJobRunLogsOptions) (result *SalIntegrationEnrichmentJobRunLogs, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentJobRunLogsWithContext(ctx context.Context, getSalIntegrationEnrichmentJobRunLogsOptions *GetSalIntegrationEnrichmentJobRunLogsOptions) (result *SalIntegrationEnrichmentJobRunLogs, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentJobRunLogs> getSalIntegrationEnrichmentJobRunLogs(GetSalIntegrationEnrichmentJobRunLogsOptions getSalIntegrationEnrichmentJobRunLogsOptions)
get_sal_integration_enrichment_job_run_logs(
        self,
        *,
        job_id: Optional[str] = None,
        job_run_id: Optional[str] = None,
        project_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationEnrichmentJobRunLogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_enrichment_job_run_logs.get

Get semantic enrichment job runs associated with the schema

Get semantic enrichment job runs associated with the schema

Get semantic enrichment job runs associated with the schema.

Get semantic enrichment job runs associated with the schema.

Get semantic enrichment job runs associated with the schema.

Get semantic enrichment job runs associated with the schema.

GET /sal_integrations/enrichment_job_runs
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentJobRuns(getSalIntegrationEnrichmentJobRunsOptions *GetSalIntegrationEnrichmentJobRunsOptions) (result *SalIntegrationEnrichmentJobRun, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentJobRunsWithContext(ctx context.Context, getSalIntegrationEnrichmentJobRunsOptions *GetSalIntegrationEnrichmentJobRunsOptions) (result *SalIntegrationEnrichmentJobRun, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentJobRun> getSalIntegrationEnrichmentJobRuns(GetSalIntegrationEnrichmentJobRunsOptions getSalIntegrationEnrichmentJobRunsOptions)
get_sal_integration_enrichment_job_runs(
        self,
        *,
        job_id: Optional[str] = None,
        project_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationEnrichmentJobRuns(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_enrichment_job_runs.get

Get semantic enrichment jobs associated with the schema

Get semantic enrichment jobs associated with the schema

Get semantic enrichment jobs associated with the schema.

Get semantic enrichment jobs associated with the schema.

Get semantic enrichment jobs associated with the schema.

Get semantic enrichment jobs associated with the schema.

GET /sal_integrations/enrichment_jobs
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentJobs(getSalIntegrationEnrichmentJobsOptions *GetSalIntegrationEnrichmentJobsOptions) (result *SalIntegrationEnrichmentJobs, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentJobsWithContext(ctx context.Context, getSalIntegrationEnrichmentJobsOptions *GetSalIntegrationEnrichmentJobsOptions) (result *SalIntegrationEnrichmentJobs, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentJobs> getSalIntegrationEnrichmentJobs(GetSalIntegrationEnrichmentJobsOptions getSalIntegrationEnrichmentJobsOptions)
get_sal_integration_enrichment_jobs(
        self,
        *,
        wkc_project_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationEnrichmentJobs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_enrichment_jobs.get

Get list of uploaded glossary terms

Get list of uploaded glossary terms

Get list of uploaded glossary terms.

Get list of uploaded glossary terms.

Get list of uploaded glossary terms.

Get list of uploaded glossary terms.

GET /sal_integrations/glossary_terms
(watsonxData *WatsonxDataV2) GetSalIntegrationGlossaryTerms(getSalIntegrationGlossaryTermsOptions *GetSalIntegrationGlossaryTermsOptions) (result *SalIntegrationGlossaryTerms, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationGlossaryTermsWithContext(ctx context.Context, getSalIntegrationGlossaryTermsOptions *GetSalIntegrationGlossaryTermsOptions) (result *SalIntegrationGlossaryTerms, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationGlossaryTerms> getSalIntegrationGlossaryTerms(GetSalIntegrationGlossaryTermsOptions getSalIntegrationGlossaryTermsOptions)
get_sal_integration_glossary_terms(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationGlossaryTerms(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_glossary_terms.get

Get wkc catalog and project mapped to the schema

Get wkc catalog and project mapped to the schema

Get wkc catalog and project mapped to the schema.

Get wkc catalog and project mapped to the schema.

Get wkc catalog and project mapped to the schema.

Get wkc catalog and project mapped to the schema.

GET /sal_integrations/mappings
(watsonxData *WatsonxDataV2) GetSalIntegrationMappings(getSalIntegrationMappingsOptions *GetSalIntegrationMappingsOptions) (result *SalIntegrationMappings, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationMappingsWithContext(ctx context.Context, getSalIntegrationMappingsOptions *GetSalIntegrationMappingsOptions) (result *SalIntegrationMappings, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationMappings> getSalIntegrationMappings(GetSalIntegrationMappingsOptions getSalIntegrationMappingsOptions)
get_sal_integration_mappings(
        self,
        catalog_name: str,
        schema_name: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationMappings(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_mappings.get

Get metadata enrichment global settings

Get metadata enrichment global settings

Get metadata enrichment global settings.

Get metadata enrichment global settings.

Get metadata enrichment global settings.

Get metadata enrichment global settings.

GET /sal_integrations/metadata_enrichment_global_settings
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentGlobalSettings(getSalIntegrationEnrichmentGlobalSettingsOptions *GetSalIntegrationEnrichmentGlobalSettingsOptions) (result *SalIntegrationEnrichmentSettings, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentGlobalSettingsWithContext(ctx context.Context, getSalIntegrationEnrichmentGlobalSettingsOptions *GetSalIntegrationEnrichmentGlobalSettingsOptions) (result *SalIntegrationEnrichmentSettings, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentSettings> getSalIntegrationEnrichmentGlobalSettings(GetSalIntegrationEnrichmentGlobalSettingsOptions getSalIntegrationEnrichmentGlobalSettingsOptions)
get_sal_integration_enrichment_global_settings(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationEnrichmentGlobalSettings(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_metadata_enrichment_global_settings.get

Add metadata enrichment global settings

Add metadata enrichment global settings

Add metadata enrichment global settings.

Add metadata enrichment global settings.

Add metadata enrichment global settings.

Add metadata enrichment global settings.

POST /sal_integrations/metadata_enrichment_global_settings
(watsonxData *WatsonxDataV2) CreateSalIntegrationEnrichmentGlobalSettings(createSalIntegrationEnrichmentGlobalSettingsOptions *CreateSalIntegrationEnrichmentGlobalSettingsOptions) (result *SalIntegrationEnrichmentSettings, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSalIntegrationEnrichmentGlobalSettingsWithContext(ctx context.Context, createSalIntegrationEnrichmentGlobalSettingsOptions *CreateSalIntegrationEnrichmentGlobalSettingsOptions) (result *SalIntegrationEnrichmentSettings, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentSettings> createSalIntegrationEnrichmentGlobalSettings(CreateSalIntegrationEnrichmentGlobalSettingsOptions createSalIntegrationEnrichmentGlobalSettingsOptions)
create_sal_integration_enrichment_global_settings(
        self,
        *,
        semantic_expansion: Optional['SalIntegrationEnrichmentSettingsSemanticExpansion'] = None,
        term_assignment: Optional['SalIntegrationEnrichmentSettingsTermAssignment'] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSalIntegrationEnrichmentGlobalSettings(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_metadata_enrichment_global_settings.post

get metadata enrichment settings for a project

get metadata enrichment settings for a project

get metadata enrichment settings for a project.

get metadata enrichment settings for a project.

get metadata enrichment settings for a project.

get metadata enrichment settings for a project.

GET /sal_integrations/metadata_enrichment_settings
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentSettings(getSalIntegrationEnrichmentSettingsOptions *GetSalIntegrationEnrichmentSettingsOptions) (result *SalIntegrationEnrichmentSettings, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationEnrichmentSettingsWithContext(ctx context.Context, getSalIntegrationEnrichmentSettingsOptions *GetSalIntegrationEnrichmentSettingsOptions) (result *SalIntegrationEnrichmentSettings, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationEnrichmentSettings> getSalIntegrationEnrichmentSettings(GetSalIntegrationEnrichmentSettingsOptions getSalIntegrationEnrichmentSettingsOptions)
get_sal_integration_enrichment_settings(
        self,
        *,
        project_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationEnrichmentSettings(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_metadata_enrichment_settings.get

Add metadata enrichment settings for a project

Add metadata enrichment settings for a project

Add metadata enrichment settings for a project.

Add metadata enrichment settings for a project.

Add metadata enrichment settings for a project.

Add metadata enrichment settings for a project.

POST /sal_integrations/metadata_enrichment_settings
(watsonxData *WatsonxDataV2) CreateSalIntegrationEnrichmentSettings(createSalIntegrationEnrichmentSettingsOptions *CreateSalIntegrationEnrichmentSettingsOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSalIntegrationEnrichmentSettingsWithContext(ctx context.Context, createSalIntegrationEnrichmentSettingsOptions *CreateSalIntegrationEnrichmentSettingsOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> createSalIntegrationEnrichmentSettings(CreateSalIntegrationEnrichmentSettingsOptions createSalIntegrationEnrichmentSettingsOptions)
create_sal_integration_enrichment_settings(
        self,
        *,
        semantic_expansion: Optional['SalIntegrationEnrichmentSettingsSemanticExpansion'] = None,
        term_assignment: Optional['SalIntegrationEnrichmentSettingsTermAssignment'] = None,
        project_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSalIntegrationEnrichmentSettings(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_metadata_enrichment_settings.create

Upload semantic enrichment business terms glossary

Upload semantic enrichment business terms glossary

Upload semantic enrichment business terms glossary.

Upload semantic enrichment business terms glossary.

Upload semantic enrichment business terms glossary.

Upload semantic enrichment business terms glossary.

POST /sal_integrations/upload_glossary
(watsonxData *WatsonxDataV2) CreateSalIntegrationUploadGlossary(createSalIntegrationUploadGlossaryOptions *CreateSalIntegrationUploadGlossaryOptions) (result *SalIntegrationUploadGlossary, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSalIntegrationUploadGlossaryWithContext(ctx context.Context, createSalIntegrationUploadGlossaryOptions *CreateSalIntegrationUploadGlossaryOptions) (result *SalIntegrationUploadGlossary, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationUploadGlossary> createSalIntegrationUploadGlossary(CreateSalIntegrationUploadGlossaryOptions createSalIntegrationUploadGlossaryOptions)
create_sal_integration_upload_glossary(
        self,
        replace_option: str,
        *,
        glossary_csv: Optional[BinaryIO] = None,
        glossary_csv_content_type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSalIntegrationUploadGlossary(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_upload_glossary.post

Get status of upload glossary job

Get status of upload glossary job

Get status of upload glossary job.

Get status of upload glossary job.

Get status of upload glossary job.

Get status of upload glossary job.

GET /sal_integrations/upload_glossary_status
(watsonxData *WatsonxDataV2) GetSalIntegrationUploadGlossaryStatus(getSalIntegrationUploadGlossaryStatusOptions *GetSalIntegrationUploadGlossaryStatusOptions) (result *SalIntegrationUploadGlossaryStatus, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSalIntegrationUploadGlossaryStatusWithContext(ctx context.Context, getSalIntegrationUploadGlossaryStatusOptions *GetSalIntegrationUploadGlossaryStatusOptions) (result *SalIntegrationUploadGlossaryStatus, response *core.DetailedResponse, err error)
ServiceCall<SalIntegrationUploadGlossaryStatus> getSalIntegrationUploadGlossaryStatus(GetSalIntegrationUploadGlossaryStatusOptions getSalIntegrationUploadGlossaryStatusOptions)
get_sal_integration_upload_glossary_status(
        self,
        *,
        process_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSalIntegrationUploadGlossaryStatus(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.sal_integration_upload_glossary_status.get

List all spark engines

List all spark engines

List all spark engines.

List all spark engines.

List all spark engines.

List all spark engines.

GET /spark_engines
(watsonxData *WatsonxDataV2) ListSparkEngines(listSparkEnginesOptions *ListSparkEnginesOptions) (result *SparkEngineCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListSparkEnginesWithContext(ctx context.Context, listSparkEnginesOptions *ListSparkEnginesOptions) (result *SparkEngineCollection, response *core.DetailedResponse, err error)
ServiceCall<SparkEngineCollection> listSparkEngines(ListSparkEnginesOptions listSparkEnginesOptions)
list_spark_engines(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listSparkEngines(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Create spark engine

Create a new spark engine

Create a new spark engine.

Create a new spark engine.

Create a new spark engine.

Create a new spark engine.

POST /spark_engines
(watsonxData *WatsonxDataV2) CreateSparkEngine(createSparkEngineOptions *CreateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSparkEngineWithContext(ctx context.Context, createSparkEngineOptions *CreateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)
ServiceCall<SparkEngine> createSparkEngine(CreateSparkEngineOptions createSparkEngineOptions)
create_spark_engine(
        self,
        origin: str,
        *,
        associated_catalogs: Optional[List[str]] = None,
        description: Optional[str] = None,
        engine_details: Optional['SparkEngineDetailsPrototype'] = None,
        engine_display_name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[List[str]] = None,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get spark engine

Get spark engine by ID

Get spark engine by ID.

Get spark engine by ID.

Get spark engine by ID.

Get spark engine by ID.

GET /spark_engines/{engine_id}
(watsonxData *WatsonxDataV2) GetSparkEngine(getSparkEngineOptions *GetSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSparkEngineWithContext(ctx context.Context, getSparkEngineOptions *GetSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)
ServiceCall<SparkEngine> getSparkEngine(GetSparkEngineOptions getSparkEngineOptions)
get_spark_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete spark engine

Delete a spark engine

Delete a spark engine.

Delete a spark engine.

Delete a spark engine.

Delete a spark engine.

DELETE /spark_engines/{engine_id}
(watsonxData *WatsonxDataV2) DeleteSparkEngine(deleteSparkEngineOptions *DeleteSparkEngineOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteSparkEngineWithContext(ctx context.Context, deleteSparkEngineOptions *DeleteSparkEngineOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteSparkEngine(DeleteSparkEngineOptions deleteSparkEngineOptions)
delete_spark_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update spark engine

Update details of spark engine

Update details of spark engine.

Update details of spark engine.

Update details of spark engine.

Update details of spark engine.

PATCH /spark_engines/{engine_id}
(watsonxData *WatsonxDataV2) UpdateSparkEngine(updateSparkEngineOptions *UpdateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateSparkEngineWithContext(ctx context.Context, updateSparkEngineOptions *UpdateSparkEngineOptions) (result *SparkEngine, response *core.DetailedResponse, err error)
ServiceCall<SparkEngine> updateSparkEngine(UpdateSparkEngineOptions updateSparkEngineOptions)
update_spark_engine(
        self,
        engine_id: str,
        body: 'UpdateSparkEngineBody',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

List all applications in a spark engine

List all applications in a spark engine

List all applications in a spark engine.

List all applications in a spark engine.

List all applications in a spark engine.

List all applications in a spark engine.

GET /spark_engines/{engine_id}/applications
(watsonxData *WatsonxDataV2) ListSparkEngineApplications(listSparkEngineApplicationsOptions *ListSparkEngineApplicationsOptions) (result *SparkEngineApplicationStatusCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListSparkEngineApplicationsWithContext(ctx context.Context, listSparkEngineApplicationsOptions *ListSparkEngineApplicationsOptions) (result *SparkEngineApplicationStatusCollection, response *core.DetailedResponse, err error)
ServiceCall<SparkEngineApplicationStatusCollection> listSparkEngineApplications(ListSparkEngineApplicationsOptions listSparkEngineApplicationsOptions)
list_spark_engine_applications(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        state: Optional[List[str]] = None,
        **kwargs,
    ) -> DetailedResponse
listSparkEngineApplications(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Submit engine applications

Submit engine applications

Submit engine applications.

Submit engine applications.

Submit engine applications.

Submit engine applications.

POST /spark_engines/{engine_id}/applications
(watsonxData *WatsonxDataV2) CreateSparkEngineApplication(createSparkEngineApplicationOptions *CreateSparkEngineApplicationOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSparkEngineApplicationWithContext(ctx context.Context, createSparkEngineApplicationOptions *CreateSparkEngineApplicationOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)
ServiceCall<SparkEngineApplicationStatus> createSparkEngineApplication(CreateSparkEngineApplicationOptions createSparkEngineApplicationOptions)
create_spark_engine_application(
        self,
        engine_id: str,
        application_details: 'SparkApplicationDetails',
        *,
        job_endpoint: Optional[str] = None,
        service_instance_id: Optional[str] = None,
        type: Optional[str] = None,
        volumes: Optional[List['SparkVolumeDetails']] = None,
        auth_instance_id: Optional[str] = None,
        state: Optional[List[str]] = None,
        **kwargs,
    ) -> DetailedResponse
createSparkEngineApplication(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Stop Spark Applications

Stop a running spark application

Stop a running spark application.

Stop a running spark application.

Stop a running spark application.

Stop a running spark application.

DELETE /spark_engines/{engine_id}/applications
(watsonxData *WatsonxDataV2) DeleteSparkEngineApplications(deleteSparkEngineApplicationsOptions *DeleteSparkEngineApplicationsOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteSparkEngineApplicationsWithContext(ctx context.Context, deleteSparkEngineApplicationsOptions *DeleteSparkEngineApplicationsOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteSparkEngineApplications(DeleteSparkEngineApplicationsOptions deleteSparkEngineApplicationsOptions)
delete_spark_engine_applications(
        self,
        engine_id: str,
        application_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        state: Optional[List[str]] = None,
        **kwargs,
    ) -> DetailedResponse
deleteSparkEngineApplications(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get spark application

Get status of spark application

Get status of spark application.

Get status of spark application.

Get status of spark application.

Get status of spark application.

GET /spark_engines/{engine_id}/applications/{application_id}
(watsonxData *WatsonxDataV2) GetSparkEngineApplicationStatus(getSparkEngineApplicationStatusOptions *GetSparkEngineApplicationStatusOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSparkEngineApplicationStatusWithContext(ctx context.Context, getSparkEngineApplicationStatusOptions *GetSparkEngineApplicationStatusOptions) (result *SparkEngineApplicationStatus, response *core.DetailedResponse, err error)
ServiceCall<SparkEngineApplicationStatus> getSparkEngineApplicationStatus(GetSparkEngineApplicationStatusOptions getSparkEngineApplicationStatusOptions)
get_spark_engine_application_status(
        self,
        engine_id: str,
        application_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSparkEngineApplicationStatus(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get spark engine catalogs

Get list of all catalogs attached to a spark engine

Get list of all catalogs attached to a spark engine.

Get list of all catalogs attached to a spark engine.

Get list of all catalogs attached to a spark engine.

Get list of all catalogs attached to a spark engine.

GET /spark_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) ListSparkEngineCatalogs(listSparkEngineCatalogsOptions *ListSparkEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListSparkEngineCatalogsWithContext(ctx context.Context, listSparkEngineCatalogsOptions *ListSparkEngineCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
ServiceCall<CatalogCollection> listSparkEngineCatalogs(ListSparkEngineCatalogsOptions listSparkEngineCatalogsOptions)
list_spark_engine_catalogs(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listSparkEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Associate catalogs to spark engine

Associate one or more catalogs to a spark engine

Associate one or more catalogs to a spark engine.

Associate one or more catalogs to a spark engine.

Associate one or more catalogs to a spark engine.

Associate one or more catalogs to a spark engine.

POST /spark_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) CreateSparkEngineCatalogs(createSparkEngineCatalogsOptions *CreateSparkEngineCatalogsOptions) (result *Catalog, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSparkEngineCatalogsWithContext(ctx context.Context, createSparkEngineCatalogsOptions *CreateSparkEngineCatalogsOptions) (result *Catalog, response *core.DetailedResponse, err error)
ServiceCall<Catalog> createSparkEngineCatalogs(CreateSparkEngineCatalogsOptions createSparkEngineCatalogsOptions)
create_spark_engine_catalogs(
        self,
        engine_id: str,
        *,
        catalog_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSparkEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Disassociate catalogs from a spark engine

Disassociate one or more catalogs from a spark engine

Disassociate one or more catalogs from a spark engine.

Disassociate one or more catalogs from a spark engine.

Disassociate one or more catalogs from a spark engine.

Disassociate one or more catalogs from a spark engine.

DELETE /spark_engines/{engine_id}/catalogs
(watsonxData *WatsonxDataV2) DeleteSparkEngineCatalogs(deleteSparkEngineCatalogsOptions *DeleteSparkEngineCatalogsOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteSparkEngineCatalogsWithContext(ctx context.Context, deleteSparkEngineCatalogsOptions *DeleteSparkEngineCatalogsOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteSparkEngineCatalogs(DeleteSparkEngineCatalogsOptions deleteSparkEngineCatalogsOptions)
delete_spark_engine_catalogs(
        self,
        engine_id: str,
        catalog_names: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteSparkEngineCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get spark engine catalog

Get catalog attached to spark engine

Get catalog attached to spark engine.

Get catalog attached to spark engine.

Get catalog attached to spark engine.

Get catalog attached to spark engine.

GET /spark_engines/{engine_id}/catalogs/{catalog_id}
(watsonxData *WatsonxDataV2) GetSparkEngineCatalog(getSparkEngineCatalogOptions *GetSparkEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSparkEngineCatalogWithContext(ctx context.Context, getSparkEngineCatalogOptions *GetSparkEngineCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
ServiceCall<Catalog> getSparkEngineCatalog(GetSparkEngineCatalogOptions getSparkEngineCatalogOptions)
get_spark_engine_catalog(
        self,
        engine_id: str,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSparkEngineCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get spark history server

Get spark history server

Get spark history server.

Get spark history server.

Get spark history server.

Get spark history server.

GET /spark_engines/{engine_id}/history_server
(watsonxData *WatsonxDataV2) GetSparkEngineHistoryServer(getSparkEngineHistoryServerOptions *GetSparkEngineHistoryServerOptions) (result *SparkHistoryServer, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSparkEngineHistoryServerWithContext(ctx context.Context, getSparkEngineHistoryServerOptions *GetSparkEngineHistoryServerOptions) (result *SparkHistoryServer, response *core.DetailedResponse, err error)
ServiceCall<SparkHistoryServer> getSparkEngineHistoryServer(GetSparkEngineHistoryServerOptions getSparkEngineHistoryServerOptions)
get_spark_engine_history_server(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSparkEngineHistoryServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Start spark history server

Start spark history server

Start spark history server.

Start spark history server.

Start spark history server.

Start spark history server.

POST /spark_engines/{engine_id}/history_server
(watsonxData *WatsonxDataV2) StartSparkEngineHistoryServer(startSparkEngineHistoryServerOptions *StartSparkEngineHistoryServerOptions) (result *SparkHistoryServer, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) StartSparkEngineHistoryServerWithContext(ctx context.Context, startSparkEngineHistoryServerOptions *StartSparkEngineHistoryServerOptions) (result *SparkHistoryServer, response *core.DetailedResponse, err error)
ServiceCall<SparkHistoryServer> startSparkEngineHistoryServer(StartSparkEngineHistoryServerOptions startSparkEngineHistoryServerOptions)
start_spark_engine_history_server(
        self,
        engine_id: str,
        *,
        cores: Optional[str] = None,
        memory: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
startSparkEngineHistoryServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Stop spark history server

Stop spark history server

Stop spark history server.

Stop spark history server.

Stop spark history server.

Stop spark history server.

DELETE /spark_engines/{engine_id}/history_server
(watsonxData *WatsonxDataV2) DeleteSparkEngineHistoryServer(deleteSparkEngineHistoryServerOptions *DeleteSparkEngineHistoryServerOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteSparkEngineHistoryServerWithContext(ctx context.Context, deleteSparkEngineHistoryServerOptions *DeleteSparkEngineHistoryServerOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteSparkEngineHistoryServer(DeleteSparkEngineHistoryServerOptions deleteSparkEngineHistoryServerOptions)
delete_spark_engine_history_server(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteSparkEngineHistoryServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Pause engine

Pause engine

Pause engine.

Pause engine.

Pause engine.

Pause engine.

POST /spark_engines/{engine_id}/pause
(watsonxData *WatsonxDataV2) PauseSparkEngine(pauseSparkEngineOptions *PauseSparkEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) PauseSparkEngineWithContext(ctx context.Context, pauseSparkEngineOptions *PauseSparkEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> pauseSparkEngine(PauseSparkEngineOptions pauseSparkEngineOptions)
pause_spark_engine(
        self,
        engine_id: str,
        *,
        force: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
pauseSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Resume engine

Resume engine

Resume engine.

Resume engine.

Resume engine.

Resume engine.

POST /spark_engines/{engine_id}/resume
(watsonxData *WatsonxDataV2) ResumeSparkEngine(resumeSparkEngineOptions *ResumeSparkEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ResumeSparkEngineWithContext(ctx context.Context, resumeSparkEngineOptions *ResumeSparkEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> resumeSparkEngine(ResumeSparkEngineOptions resumeSparkEngineOptions)
resume_spark_engine(
        self,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
resumeSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Scale Spark engine

Scale Saprk engine

Scale Saprk engine.

Scale Saprk engine.

Scale Saprk engine.

Scale Saprk engine.

POST /spark_engines/{engine_id}/scale
(watsonxData *WatsonxDataV2) ScaleSparkEngine(scaleSparkEngineOptions *ScaleSparkEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ScaleSparkEngineWithContext(ctx context.Context, scaleSparkEngineOptions *ScaleSparkEngineOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> scaleSparkEngine(ScaleSparkEngineOptions scaleSparkEngineOptions)
scale_spark_engine(
        self,
        engine_id: str,
        *,
        number_of_nodes: Optional[int] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
scaleSparkEngine(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

List spark version

List spark version

List spark version.

List spark version.

List spark version.

List spark version.

GET /spark_versions
(watsonxData *WatsonxDataV2) ListSparkVersions(listSparkVersionsOptions *ListSparkVersionsOptions) (result *ListSparkVersionsOKBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListSparkVersionsWithContext(ctx context.Context, listSparkVersionsOptions *ListSparkVersionsOptions) (result *ListSparkVersionsOKBody, response *core.DetailedResponse, err error)
ServiceCall<ListSparkVersionsOKBody> listSparkVersions(ListSparkVersionsOptions listSparkVersionsOptions)
list_spark_versions(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listSparkVersions(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

List all registered catalogs

List all registered catalogs

List all registered catalogs.

List all registered catalogs.

List all registered catalogs.

List all registered catalogs.

GET /catalogs
(watsonxData *WatsonxDataV2) ListCatalogs(listCatalogsOptions *ListCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListCatalogsWithContext(ctx context.Context, listCatalogsOptions *ListCatalogsOptions) (result *CatalogCollection, response *core.DetailedResponse, err error)
ServiceCall<CatalogCollection> listCatalogs(ListCatalogsOptions listCatalogsOptions)
list_catalogs(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listCatalogs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get catalog properties by catalog_id

Get catalog properties of a catalog identified by catalog_id

Get catalog properties of a catalog identified by catalog_id.

Get catalog properties of a catalog identified by catalog_id.

Get catalog properties of a catalog identified by catalog_id.

Get catalog properties of a catalog identified by catalog_id.

GET /catalogs/{catalog_id}
(watsonxData *WatsonxDataV2) GetCatalog(getCatalogOptions *GetCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetCatalogWithContext(ctx context.Context, getCatalogOptions *GetCatalogOptions) (result *Catalog, response *core.DetailedResponse, err error)
ServiceCall<Catalog> getCatalog(GetCatalogOptions getCatalogOptions)
get_catalog(
        self,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete catalog

Delete catalog identified by catalog_id

Delete catalog identified by catalog_id.

Delete catalog identified by catalog_id.

Delete catalog identified by catalog_id.

Delete catalog identified by catalog_id.

DELETE /catalogs/{catalog_id}
(watsonxData *WatsonxDataV2) DeleteCatalog(deleteCatalogOptions *DeleteCatalogOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteCatalogWithContext(ctx context.Context, deleteCatalogOptions *DeleteCatalogOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteCatalog(DeleteCatalogOptions deleteCatalogOptions)
delete_catalog(
        self,
        catalog_id: str,
        *,
        skip_mds_call: Optional[bool] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.catalog.delete

List all schemas

List all schemas in catalog

List all schemas in catalog.

List all schemas in catalog.

List all schemas in catalog.

List all schemas in catalog.

GET /catalogs/{catalog_id}/schemas
(watsonxData *WatsonxDataV2) ListSchemas(listSchemasOptions *ListSchemasOptions) (result *ListSchemasOKBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListSchemasWithContext(ctx context.Context, listSchemasOptions *ListSchemasOptions) (result *ListSchemasOKBody, response *core.DetailedResponse, err error)
ServiceCall<ListSchemasOKBody> listSchemas(ListSchemasOptions listSchemasOptions)
list_schemas(
        self,
        engine_id: str,
        catalog_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listSchemas(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.schema.list

Create schema

Create a new schema

Create a new schema.

Create a new schema.

Create a new schema.

Create a new schema.

POST /catalogs/{catalog_id}/schemas
(watsonxData *WatsonxDataV2) CreateSchema(createSchemaOptions *CreateSchemaOptions) (result *CreateSchemaCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateSchemaWithContext(ctx context.Context, createSchemaOptions *CreateSchemaOptions) (result *CreateSchemaCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<CreateSchemaCreatedBody> createSchema(CreateSchemaOptions createSchemaOptions)
create_schema(
        self,
        engine_id: str,
        catalog_id: str,
        custom_path: str,
        schema_name: str,
        *,
        bucket_name: Optional[str] = None,
        hostname: Optional[str] = None,
        port: Optional[int] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createSchema(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.schema.create

Delete schema

Delete a schema

Delete a schema.

Delete a schema.

Delete a schema.

Delete a schema.

DELETE /catalogs/{catalog_id}/schemas/{schema_id}
(watsonxData *WatsonxDataV2) DeleteSchema(deleteSchemaOptions *DeleteSchemaOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteSchemaWithContext(ctx context.Context, deleteSchemaOptions *DeleteSchemaOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteSchema(DeleteSchemaOptions deleteSchemaOptions)
delete_schema(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteSchema(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

List all tables

List all tables in a schema in a catalog for a given engine

List all tables in a schema in a catalog for a given engine.

List all tables in a schema in a catalog for a given engine.

List all tables in a schema in a catalog for a given engine.

List all tables in a schema in a catalog for a given engine.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables
(watsonxData *WatsonxDataV2) ListTables(listTablesOptions *ListTablesOptions) (result *TableCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListTablesWithContext(ctx context.Context, listTablesOptions *ListTablesOptions) (result *TableCollection, response *core.DetailedResponse, err error)
ServiceCall<TableCollection> listTables(ListTablesOptions listTablesOptions)
list_tables(
        self,
        catalog_id: str,
        schema_id: str,
        engine_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listTables(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get table details

Get details of a given table in a catalog and schema

Get details of a given table in a catalog and schema.

Get details of a given table in a catalog and schema.

Get details of a given table in a catalog and schema.

Get details of a given table in a catalog and schema.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}
(watsonxData *WatsonxDataV2) GetTable(getTableOptions *GetTableOptions) (result *Table, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetTableWithContext(ctx context.Context, getTableOptions *GetTableOptions) (result *Table, response *core.DetailedResponse, err error)
ServiceCall<Table> getTable(GetTableOptions getTableOptions)
get_table(
        self,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        engine_id: str,
        *,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete table

Delete table for a given schema and catalog

Delete table for a given schema and catalog.

Delete table for a given schema and catalog.

Delete table for a given schema and catalog.

Delete table for a given schema and catalog.

DELETE /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}
(watsonxData *WatsonxDataV2) DeleteTable(deleteTableOptions *DeleteTableOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteTableWithContext(ctx context.Context, deleteTableOptions *DeleteTableOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteTable(DeleteTableOptions deleteTableOptions)
delete_table(
        self,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        engine_id: str,
        *,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Rename table

Rename table

Rename table.

Rename table.

Rename table.

Rename table.

PATCH /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}
(watsonxData *WatsonxDataV2) UpdateTable(updateTableOptions *UpdateTableOptions) (result *Table, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateTableWithContext(ctx context.Context, updateTableOptions *UpdateTableOptions) (result *Table, response *core.DetailedResponse, err error)
ServiceCall<Table> updateTable(UpdateTableOptions updateTableOptions)
update_table(
        self,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        engine_id: str,
        body: 'TablePatch',
        *,
        type: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

List all columns of a table

List all columns of a table in a given a schema for a given catalog

List all columns of a table in a given a schema for a given catalog.

List all columns of a table in a given a schema for a given catalog.

List all columns of a table in a given a schema for a given catalog.

List all columns of a table in a given a schema for a given catalog.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns
(watsonxData *WatsonxDataV2) ListColumns(listColumnsOptions *ListColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListColumnsWithContext(ctx context.Context, listColumnsOptions *ListColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)
ServiceCall<ColumnCollection> listColumns(ListColumnsOptions listColumnsOptions)
list_columns(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listColumns(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.column.list

Add column(s)

Add one or multiple columns to a table in a schema for a given catalog

Add one or multiple columns to a table in a schema for a given catalog.

Add one or multiple columns to a table in a schema for a given catalog.

Add one or multiple columns to a table in a schema for a given catalog.

Add one or multiple columns to a table in a schema for a given catalog.

POST /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns
(watsonxData *WatsonxDataV2) CreateColumns(createColumnsOptions *CreateColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateColumnsWithContext(ctx context.Context, createColumnsOptions *CreateColumnsOptions) (result *ColumnCollection, response *core.DetailedResponse, err error)
ServiceCall<ColumnCollection> createColumns(CreateColumnsOptions createColumnsOptions)
create_columns(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        columns: Optional[List['Column']] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createColumns(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.column.create

Delete column

Delete column in a table for a given schema and catalog

Delete column in a table for a given schema and catalog.

Delete column in a table for a given schema and catalog.

Delete column in a table for a given schema and catalog.

Delete column in a table for a given schema and catalog.

DELETE /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns/{column_id}
(watsonxData *WatsonxDataV2) DeleteColumn(deleteColumnOptions *DeleteColumnOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteColumnWithContext(ctx context.Context, deleteColumnOptions *DeleteColumnOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteColumn(DeleteColumnOptions deleteColumnOptions)
delete_column(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        column_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteColumn(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Alter column

Update the given column - rename column

Update the given column - rename column.

Update the given column - rename column.

Update the given column - rename column.

Update the given column - rename column.

PATCH /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/columns/{column_id}
(watsonxData *WatsonxDataV2) UpdateColumn(updateColumnOptions *UpdateColumnOptions) (result *Column, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateColumnWithContext(ctx context.Context, updateColumnOptions *UpdateColumnOptions) (result *Column, response *core.DetailedResponse, err error)
ServiceCall<Column> updateColumn(UpdateColumnOptions updateColumnOptions)
update_column(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        column_id: str,
        body: 'ColumnPatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateColumn(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get table snapshots

List all table snapshots

List all table snapshots.

List all table snapshots.

List all table snapshots.

List all table snapshots.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/snapshots
(watsonxData *WatsonxDataV2) ListTableSnapshots(listTableSnapshotsOptions *ListTableSnapshotsOptions) (result *TableSnapshotCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListTableSnapshotsWithContext(ctx context.Context, listTableSnapshotsOptions *ListTableSnapshotsOptions) (result *TableSnapshotCollection, response *core.DetailedResponse, err error)
ServiceCall<TableSnapshotCollection> listTableSnapshots(ListTableSnapshotsOptions listTableSnapshotsOptions)
list_table_snapshots(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listTableSnapshots(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.table_snapshot.list

Rollback table to snapshot

Rollback table to a snapshot

Rollback table to a snapshot.

Rollback table to a snapshot.

Rollback table to a snapshot.

Rollback table to a snapshot.

POST /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/rollback
(watsonxData *WatsonxDataV2) RollbackTable(rollbackTableOptions *RollbackTableOptions) (result *ReplaceSnapshotCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RollbackTableWithContext(ctx context.Context, rollbackTableOptions *RollbackTableOptions) (result *ReplaceSnapshotCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<ReplaceSnapshotCreatedBody> rollbackTable(RollbackTableOptions rollbackTableOptions)
rollback_table(
        self,
        engine_id: str,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        snapshot_id: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
rollbackTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

External Iceberg table registration

Synchronize the external Iceberg table registration for a catalog identified by catalog_id.

Synchronize the external Iceberg table registration for a catalog identified by catalog_id.

Synchronize the external Iceberg table registration for a catalog identified by catalog_id.

Synchronize the external Iceberg table registration for a catalog identified by catalog_id.

Synchronize the external Iceberg table registration for a catalog identified by catalog_id.

PATCH /catalogs/{catalog_id}/sync
(watsonxData *WatsonxDataV2) UpdateSyncCatalog(updateSyncCatalogOptions *UpdateSyncCatalogOptions) (result *UpdateSyncCatalogOKBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateSyncCatalogWithContext(ctx context.Context, updateSyncCatalogOptions *UpdateSyncCatalogOptions) (result *UpdateSyncCatalogOKBody, response *core.DetailedResponse, err error)
ServiceCall<UpdateSyncCatalogOKBody> updateSyncCatalog(UpdateSyncCatalogOptions updateSyncCatalogOptions)
update_sync_catalog(
        self,
        catalog_id: str,
        body: 'SyncCatalogs',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateSyncCatalog(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Get list of milvus services

Get list milvus services

Get list milvus services.

Get list milvus services.

Get list milvus services.

Get list milvus services.

GET /milvus_services
(watsonxData *WatsonxDataV2) ListMilvusServices(listMilvusServicesOptions *ListMilvusServicesOptions) (result *MilvusServiceCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListMilvusServicesWithContext(ctx context.Context, listMilvusServicesOptions *ListMilvusServicesOptions) (result *MilvusServiceCollection, response *core.DetailedResponse, err error)
ServiceCall<MilvusServiceCollection> listMilvusServices(ListMilvusServicesOptions listMilvusServicesOptions)
list_milvus_services(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listMilvusServices(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_service.read

Create milvus service

Create milvus service

Create milvus service.

Create milvus service.

Create milvus service.

Create milvus service.

POST /milvus_services
(watsonxData *WatsonxDataV2) CreateMilvusService(createMilvusServiceOptions *CreateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateMilvusServiceWithContext(ctx context.Context, createMilvusServiceOptions *CreateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)
ServiceCall<MilvusService> createMilvusService(CreateMilvusServiceOptions createMilvusServiceOptions)
create_milvus_service(
        self,
        bucket_name: str,
        origin: str,
        root_path: str,
        service_display_name: str,
        *,
        bucket_type: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[List[str]] = None,
        tshirt_size: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_service.create

Get milvus service

Get milvus service

Get milvus service.

Get milvus service.

Get milvus service.

Get milvus service.

GET /milvus_services/{service_id}
(watsonxData *WatsonxDataV2) GetMilvusService(getMilvusServiceOptions *GetMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetMilvusServiceWithContext(ctx context.Context, getMilvusServiceOptions *GetMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)
ServiceCall<MilvusService> getMilvusService(GetMilvusServiceOptions getMilvusServiceOptions)
get_milvus_service(
        self,
        service_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Delete milvus service

Delete milvus service

Delete milvus service.

Delete milvus service.

Delete milvus service.

Delete milvus service.

DELETE /milvus_services/{service_id}
(watsonxData *WatsonxDataV2) DeleteMilvusService(deleteMilvusServiceOptions *DeleteMilvusServiceOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteMilvusServiceWithContext(ctx context.Context, deleteMilvusServiceOptions *DeleteMilvusServiceOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteMilvusService(DeleteMilvusServiceOptions deleteMilvusServiceOptions)
delete_milvus_service(
        self,
        service_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
deleteMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update milvus service

Update details of milvus service

Update details of milvus service.

Update details of milvus service.

Update details of milvus service.

Update details of milvus service.

PATCH /milvus_services/{service_id}
(watsonxData *WatsonxDataV2) UpdateMilvusService(updateMilvusServiceOptions *UpdateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateMilvusServiceWithContext(ctx context.Context, updateMilvusServiceOptions *UpdateMilvusServiceOptions) (result *MilvusService, response *core.DetailedResponse, err error)
ServiceCall<MilvusService> updateMilvusService(UpdateMilvusServiceOptions updateMilvusServiceOptions)
update_milvus_service(
        self,
        service_id: str,
        body: 'MilvusServicePatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateMilvusService(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.dashboard.view

Update milvus service bucket

Update details of milvus service bucket. Note that the improper use of the API could result in potential data loss.

Update details of milvus service bucket. Note that the improper use of the API could result in potential data loss.

Update details of milvus service bucket. Note that the improper use of the API could result in potential data loss.

Update details of milvus service bucket. Note that the improper use of the API could result in potential data loss.

Update details of milvus service bucket. Note that the improper use of the API could result in potential data loss.

PATCH /milvus_services/{service_id}/bucket
(watsonxData *WatsonxDataV2) UpdateMilvusServiceBucket(updateMilvusServiceBucketOptions *UpdateMilvusServiceBucketOptions) (result *MilvusService, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) UpdateMilvusServiceBucketWithContext(ctx context.Context, updateMilvusServiceBucketOptions *UpdateMilvusServiceBucketOptions) (result *MilvusService, response *core.DetailedResponse, err error)
ServiceCall<MilvusService> updateMilvusServiceBucket(UpdateMilvusServiceBucketOptions updateMilvusServiceBucketOptions)
update_milvus_service_bucket(
        self,
        service_id: str,
        body: 'MilvusServiceBucketPatch',
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
updateMilvusServiceBucket(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_service.update.bucket

Get milvus service databases

Get milvus service databases

Get milvus service databases.

Get milvus service databases.

Get milvus service databases.

Get milvus service databases.

GET /milvus_services/{service_id}/databases
(watsonxData *WatsonxDataV2) ListMilvusServiceDatabases(listMilvusServiceDatabasesOptions *ListMilvusServiceDatabasesOptions) (result *MilvusServiceDatabases, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListMilvusServiceDatabasesWithContext(ctx context.Context, listMilvusServiceDatabasesOptions *ListMilvusServiceDatabasesOptions) (result *MilvusServiceDatabases, response *core.DetailedResponse, err error)
ServiceCall<MilvusServiceDatabases> listMilvusServiceDatabases(ListMilvusServiceDatabasesOptions listMilvusServiceDatabasesOptions)
list_milvus_service_databases(
        self,
        service_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listMilvusServiceDatabases(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_service_databases.get

Get milvus database collections

Get milvus database collections

Get milvus database collections.

Get milvus database collections.

Get milvus database collections.

Get milvus database collections.

GET /milvus_services/{service_id}/databases/{database_id}/collections
(watsonxData *WatsonxDataV2) ListMilvusDatabaseCollections(listMilvusDatabaseCollectionsOptions *ListMilvusDatabaseCollectionsOptions) (result *MilvusDatabaseCollections, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListMilvusDatabaseCollectionsWithContext(ctx context.Context, listMilvusDatabaseCollectionsOptions *ListMilvusDatabaseCollectionsOptions) (result *MilvusDatabaseCollections, response *core.DetailedResponse, err error)
ServiceCall<MilvusDatabaseCollections> listMilvusDatabaseCollections(ListMilvusDatabaseCollectionsOptions listMilvusDatabaseCollectionsOptions)
list_milvus_database_collections(
        self,
        service_id: str,
        database_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listMilvusDatabaseCollections(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_database_collections.get

Pause milvus service

Pause a running milvus service

Pause a running milvus service.

Pause a running milvus service.

Pause a running milvus service.

Pause a running milvus service.

POST /milvus_services/{service_id}/pause
(watsonxData *WatsonxDataV2) CreateMilvusServicePause(createMilvusServicePauseOptions *CreateMilvusServicePauseOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateMilvusServicePauseWithContext(ctx context.Context, createMilvusServicePauseOptions *CreateMilvusServicePauseOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> createMilvusServicePause(CreateMilvusServicePauseOptions createMilvusServicePauseOptions)
create_milvus_service_pause(
        self,
        service_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createMilvusServicePause(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_service.pause

Resume milvus service

Resume a paused milvus service

Resume a paused milvus service.

Resume a paused milvus service.

Resume a paused milvus service.

Resume a paused milvus service.

POST /milvus_services/{service_id}/resume
(watsonxData *WatsonxDataV2) CreateMilvusServiceResume(createMilvusServiceResumeOptions *CreateMilvusServiceResumeOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateMilvusServiceResumeWithContext(ctx context.Context, createMilvusServiceResumeOptions *CreateMilvusServiceResumeOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> createMilvusServiceResume(CreateMilvusServiceResumeOptions createMilvusServiceResumeOptions)
create_milvus_service_resume(
        self,
        service_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createMilvusServiceResume(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_service.resume

Scale a milvus service

Scale an existing milvus service

Scale an existing milvus service.

Scale an existing milvus service.

Scale an existing milvus service.

Scale an existing milvus service.

POST /milvus_services/{service_id}/scale
(watsonxData *WatsonxDataV2) CreateMilvusServiceScale(createMilvusServiceScaleOptions *CreateMilvusServiceScaleOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateMilvusServiceScaleWithContext(ctx context.Context, createMilvusServiceScaleOptions *CreateMilvusServiceScaleOptions) (result *SuccessResponse, response *core.DetailedResponse, err error)
ServiceCall<SuccessResponse> createMilvusServiceScale(CreateMilvusServiceScaleOptions createMilvusServiceScaleOptions)
create_milvus_service_scale(
        self,
        service_id: str,
        *,
        tshirt_size: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createMilvusServiceScale(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.milvus_service.scale

Get ingestion jobs

Get list of ingestion jobs

Get list of ingestion jobs.

Get list of ingestion jobs.

Get list of ingestion jobs.

Get list of ingestion jobs.

GET /ingestion_jobs
(watsonxData *WatsonxDataV2) ListIngestionJobs(listIngestionJobsOptions *ListIngestionJobsOptions) (result *IngestionJobCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListIngestionJobsWithContext(ctx context.Context, listIngestionJobsOptions *ListIngestionJobsOptions) (result *IngestionJobCollection, response *core.DetailedResponse, err error)
ServiceCall<IngestionJobCollection> listIngestionJobs(ListIngestionJobsOptions listIngestionJobsOptions)
list_ingestion_jobs(
        self,
        auth_instance_id: str,
        *,
        start: Optional[str] = None,
        jobs_per_page: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
listIngestionJobs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.ingestion_jobs.list

Create an ingestion job

Create an ingestion job

Create an ingestion job.

Create an ingestion job.

Create an ingestion job.

Create an ingestion job.

POST /ingestion_jobs
(watsonxData *WatsonxDataV2) CreateIngestionJobs(createIngestionJobsOptions *CreateIngestionJobsOptions) (result *IngestionJob, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateIngestionJobsWithContext(ctx context.Context, createIngestionJobsOptions *CreateIngestionJobsOptions) (result *IngestionJob, response *core.DetailedResponse, err error)
ServiceCall<IngestionJob> createIngestionJobs(CreateIngestionJobsOptions createIngestionJobsOptions)
create_ingestion_jobs(
        self,
        auth_instance_id: str,
        job_id: str,
        source_data_files: str,
        target_table: str,
        username: str,
        *,
        create_if_not_exist: Optional[bool] = None,
        csv_property: Optional['IngestionJobPrototypeCsvProperty'] = None,
        engine_id: Optional[str] = None,
        execute_config: Optional['IngestionJobPrototypeExecuteConfig'] = None,
        partition_by: Optional[str] = None,
        schema: Optional[str] = None,
        source_file_type: Optional[str] = None,
        validate_csv_header: Optional[bool] = None,
        **kwargs,
    ) -> DetailedResponse
createIngestionJobs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.ingestion_jobs.create

Create an ingestion job for user local files

Create an ingestion job for user local files

Create an ingestion job for user local files.

Create an ingestion job for user local files.

Create an ingestion job for user local files.

Create an ingestion job for user local files.

POST /ingestion_jobs_local_files
(watsonxData *WatsonxDataV2) CreateIngestionJobsLocalFiles(createIngestionJobsLocalFilesOptions *CreateIngestionJobsLocalFilesOptions) (result *IngestionJob, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreateIngestionJobsLocalFilesWithContext(ctx context.Context, createIngestionJobsLocalFilesOptions *CreateIngestionJobsLocalFilesOptions) (result *IngestionJob, response *core.DetailedResponse, err error)
ServiceCall<IngestionJob> createIngestionJobsLocalFiles(CreateIngestionJobsLocalFilesOptions createIngestionJobsLocalFilesOptions)
create_ingestion_jobs_local_files(
        self,
        auth_instance_id: str,
        source_data_file: BinaryIO,
        target_table: str,
        job_id: str,
        username: str,
        *,
        source_data_file_content_type: Optional[str] = None,
        source_file_type: Optional[str] = None,
        csv_property: Optional[str] = None,
        create_if_not_exist: Optional[bool] = None,
        validate_csv_header: Optional[bool] = None,
        execute_config: Optional[str] = None,
        engine_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createIngestionJobsLocalFiles(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.ingestion_jobs.create

Get ingestion job

Get a submitted ingestion job

Get a submitted ingestion job.

Get a submitted ingestion job.

Get a submitted ingestion job.

Get a submitted ingestion job.

GET /ingestion_jobs/{job_id}
(watsonxData *WatsonxDataV2) GetIngestionJob(getIngestionJobOptions *GetIngestionJobOptions) (result *IngestionJob, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetIngestionJobWithContext(ctx context.Context, getIngestionJobOptions *GetIngestionJobOptions) (result *IngestionJob, response *core.DetailedResponse, err error)
ServiceCall<IngestionJob> getIngestionJob(GetIngestionJobOptions getIngestionJobOptions)
get_ingestion_job(
        self,
        job_id: str,
        auth_instance_id: str,
        **kwargs,
    ) -> DetailedResponse
getIngestionJob(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.ingestion_job.get

Delete an ingestion job

Delete an ingestion job

Delete an ingestion job.

Delete an ingestion job.

Delete an ingestion job.

Delete an ingestion job.

DELETE /ingestion_jobs/{job_id}
(watsonxData *WatsonxDataV2) DeleteIngestionJobs(deleteIngestionJobsOptions *DeleteIngestionJobsOptions) (response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) DeleteIngestionJobsWithContext(ctx context.Context, deleteIngestionJobsOptions *DeleteIngestionJobsOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteIngestionJobs(DeleteIngestionJobsOptions deleteIngestionJobsOptions)
delete_ingestion_jobs(
        self,
        job_id: str,
        auth_instance_id: str,
        **kwargs,
    ) -> DetailedResponse
deleteIngestionJobs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.ingestion_jobs.delete

Generate a preview of source file(s)

Generate a preview of source file(s)

Generate a preview of source file(s).

Generate a preview of source file(s).

Generate a preview of source file(s).

Generate a preview of source file(s).

POST /preview_ingestion_file
(watsonxData *WatsonxDataV2) CreatePreviewIngestionFile(createPreviewIngestionFileOptions *CreatePreviewIngestionFileOptions) (result *PreviewIngestionFile, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) CreatePreviewIngestionFileWithContext(ctx context.Context, createPreviewIngestionFileOptions *CreatePreviewIngestionFileOptions) (result *PreviewIngestionFile, response *core.DetailedResponse, err error)
ServiceCall<PreviewIngestionFile> createPreviewIngestionFile(CreatePreviewIngestionFileOptions createPreviewIngestionFileOptions)
create_preview_ingestion_file(
        self,
        auth_instance_id: str,
        source_data_files: str,
        *,
        csv_property: Optional['PreviewIngestionFilePrototypeCsvProperty'] = None,
        source_file_type: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
createPreviewIngestionFile(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.preview_ingestion_file.create

Get CPG and DAS endpoints

Get Common policy gateway (CPG) and Data Access Service(DAS) endpoints

Get Common policy gateway (CPG) and Data Access Service(DAS) endpoints.

Get Common policy gateway (CPG) and Data Access Service(DAS) endpoints.

Get Common policy gateway (CPG) and Data Access Service(DAS) endpoints.

Get Common policy gateway (CPG) and Data Access Service(DAS) endpoints.

GET /endpoints
(watsonxData *WatsonxDataV2) GetEndpoints(getEndpointsOptions *GetEndpointsOptions) (result *EndpointCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetEndpointsWithContext(ctx context.Context, getEndpointsOptions *GetEndpointsOptions) (result *EndpointCollection, response *core.DetailedResponse, err error)
ServiceCall<EndpointCollection> getEndpoints(GetEndpointsOptions getEndpointsOptions)
get_endpoints(
        self,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getEndpoints(params)

Register delta or hudi table

Register delta or hudi table

Register delta or hudi table.

Register delta or hudi table.

Register delta or hudi table.

Register delta or hudi table.

POST /catalogs/{catalog_id}/schemas/{schema_id}/register
(watsonxData *WatsonxDataV2) RegisterTable(registerTableOptions *RegisterTableOptions) (result *RegisterTableCreatedBody, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) RegisterTableWithContext(ctx context.Context, registerTableOptions *RegisterTableOptions) (result *RegisterTableCreatedBody, response *core.DetailedResponse, err error)
ServiceCall<RegisterTableCreatedBody> registerTable(RegisterTableOptions registerTableOptions)
register_table(
        self,
        catalog_id: str,
        schema_id: str,
        metadata_location: str,
        table_name: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
registerTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.table.register

Load table metadata

Load table metadata

Load table metadata.

Load table metadata.

Load table metadata.

Load table metadata.

GET /catalogs/{catalog_id}/schemas/{schema_id}/tables/{table_id}/metadata
(watsonxData *WatsonxDataV2) LoadTable(loadTableOptions *LoadTableOptions) (result *LoadTableResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) LoadTableWithContext(ctx context.Context, loadTableOptions *LoadTableOptions) (result *LoadTableResponse, response *core.DetailedResponse, err error)
ServiceCall<LoadTableResponse> loadTable(LoadTableOptions loadTableOptions)
load_table(
        self,
        catalog_id: str,
        schema_id: str,
        table_id: str,
        *,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
loadTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.table.load

Get all columns

Get all columns

Get all columns.

Get all columns.

Get all columns.

Get all columns.

GET /columns
(watsonxData *WatsonxDataV2) GetAllColumns(getAllColumnsOptions *GetAllColumnsOptions) (result *ColumnsResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetAllColumnsWithContext(ctx context.Context, getAllColumnsOptions *GetAllColumnsOptions) (result *ColumnsResponse, response *core.DetailedResponse, err error)
ServiceCall<ColumnsResponse> getAllColumns(GetAllColumnsOptions getAllColumnsOptions)
get_all_columns(
        self,
        *,
        table_name: Optional[str] = None,
        catalog_name: Optional[str] = None,
        schema_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getAllColumns(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.columns.list

Get all schemas for a given catalog

List Schemas for a catalog with the given catalog_name

List Schemas for a catalog with the given catalog_name.

List Schemas for a catalog with the given catalog_name.

List Schemas for a catalog with the given catalog_name.

List Schemas for a catalog with the given catalog_name.

GET /schemas
(watsonxData *WatsonxDataV2) ListAllSchemas(listAllSchemasOptions *ListAllSchemasOptions) (result *SchemaResponseCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListAllSchemasWithContext(ctx context.Context, listAllSchemasOptions *ListAllSchemasOptions) (result *SchemaResponseCollection, response *core.DetailedResponse, err error)
ServiceCall<SchemaResponseCollection> listAllSchemas(ListAllSchemasOptions listAllSchemasOptions)
list_all_schemas(
        self,
        *,
        catalog_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listAllSchemas(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.schemas.list

Get schema details

Get schema details

Get schema details.

Get schema details.

Get schema details.

Get schema details.

GET /schemas/{schema_name}
(watsonxData *WatsonxDataV2) GetSchemaDetails(getSchemaDetailsOptions *GetSchemaDetailsOptions) (result *SchemaResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetSchemaDetailsWithContext(ctx context.Context, getSchemaDetailsOptions *GetSchemaDetailsOptions) (result *SchemaResponse, response *core.DetailedResponse, err error)
ServiceCall<SchemaResponse> getSchemaDetails(GetSchemaDetailsOptions getSchemaDetailsOptions)
get_schema_details(
        self,
        schema_name: str,
        *,
        catalog_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getSchemaDetails(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.schemadetails.list

Get all tables

Get all tables

Get all tables.

Get all tables.

Get all tables.

Get all tables.

GET /tables
(watsonxData *WatsonxDataV2) ListAllTables(listAllTablesOptions *ListAllTablesOptions) (result *TableResponseCollection, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) ListAllTablesWithContext(ctx context.Context, listAllTablesOptions *ListAllTablesOptions) (result *TableResponseCollection, response *core.DetailedResponse, err error)
ServiceCall<TableResponseCollection> listAllTables(ListAllTablesOptions listAllTablesOptions)
list_all_tables(
        self,
        *,
        catalog_name: Optional[str] = None,
        schema_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
listAllTables(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.tables.list

Get table details

Get table details

Get table details.

Get table details.

Get table details.

Get table details.

GET /tables/{table_name}
(watsonxData *WatsonxDataV2) GetTableDetails(getTableDetailsOptions *GetTableDetailsOptions) (result *TableResponse, response *core.DetailedResponse, err error)
(watsonxData *WatsonxDataV2) GetTableDetailsWithContext(ctx context.Context, getTableDetailsOptions *GetTableDetailsOptions) (result *TableResponse, response *core.DetailedResponse, err error)
ServiceCall<TableResponse> getTableDetails(GetTableDetailsOptions getTableDetailsOptions)
get_table_details(
        self,
        table_name: str,
        *,
        catalog_name: Optional[str] = None,
        schema_name: Optional[str] = None,
        auth_instance_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
getTableDetails(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • lakehouse.tabledetails.list

id=curlclassName=tab-item-selected
Privacy statement