Package com.ibm.cloud.watsonxdata.watsonx_data.v3

Class WatsonxData

  • public class WatsonxData
extends com.ibm.cloud.sdk.core.service.BaseService
    This is the Public API for IBM watsonx.data. API Version: 3.0.0

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `WatsonxData` client.
        See Also:
        Constant Field Values

      • DEFAULT_SERVICE_URL

        public static final java.lang.String DEFAULT_SERVICE_URL
        Default service endpoint URL.
        See Also:
        Constant Field Values

    • Constructor Detail

      • WatsonxData

        public WatsonxData​(java.lang.String serviceName,
                   com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `WatsonxData` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static WatsonxData newInstance()
        Class method which constructs an instance of the `WatsonxData` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `WatsonxData` client using external configuration

      • newInstance

        public static WatsonxData newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `WatsonxData` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `WatsonxData` client using external configuration

      • listPrestissimoEngines

        public com.ibm.cloud.sdk.core.http.ServiceCall<PrestissimoEngineCollection> listPrestissimoEngines()
        Collection of Prestissimo engines. Collection of Prestissimo engines.
        Returns:
        a ServiceCall with a result of type PrestissimoEngineCollection

      • deletePrestissimoEngine

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deletePrestissimoEngine​(DeletePrestissimoEngineOptions deletePrestissimoEngineOptions)
        Delete prestissimo engine. Delete a prestissimo engine.
        Parameters:
        deletePrestissimoEngineOptions - the DeletePrestissimoEngineOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deletePrestissimoEngineCatalogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deletePrestissimoEngineCatalogs​(DeletePrestissimoEngineCatalogsOptions deletePrestissimoEngineCatalogsOptions)
        Disassociate catalogs from a prestissimo engine. Disassociate one or more catalogs from a prestissimo engine.
        Parameters:
        deletePrestissimoEngineCatalogsOptions - the DeletePrestissimoEngineCatalogsOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listPrestoEngines

        public com.ibm.cloud.sdk.core.http.ServiceCall<PrestoEngineCollection> listPrestoEngines()
        Get list of Presto(Java) engines. Get list of all Presto(Java) engines.
        Returns:
        a ServiceCall with a result of type PrestoEngineCollection

      • createPrestoEngine

        public com.ibm.cloud.sdk.core.http.ServiceCall<PrestoEngine> createPrestoEngine​(CreatePrestoEngineOptions createPrestoEngineOptions)
        Create presto engine. Create a new presto engine.
        Parameters:
        createPrestoEngineOptions - the CreatePrestoEngineOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PrestoEngine

      • deletePrestoEngineCatalogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deletePrestoEngineCatalogs​(DeletePrestoEngineCatalogsOptions deletePrestoEngineCatalogsOptions)
        Disassociate catalogs from a presto engine. Disassociate one or more catalogs from a presto engine.
        Parameters:
        deletePrestoEngineCatalogsOptions - the DeletePrestoEngineCatalogsOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getPrestoEngine

        public com.ibm.cloud.sdk.core.http.ServiceCall<PrestoEngine> getPrestoEngine​(GetPrestoEngineOptions getPrestoEngineOptions)
        Get presto engine. Get details of one presto engine.
        Parameters:
        getPrestoEngineOptions - the GetPrestoEngineOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PrestoEngine

      • deleteEngine

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteEngine​(DeleteEngineOptions deleteEngineOptions)
        Delete presto engine. Delete a presto engine.
        Parameters:
        deleteEngineOptions - the DeleteEngineOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updatePrestoEngine

        public com.ibm.cloud.sdk.core.http.ServiceCall<PrestoEngine> updatePrestoEngine​(UpdatePrestoEngineOptions updatePrestoEngineOptions)
        Update presto engine. Update details of presto engine.
        Parameters:
        updatePrestoEngineOptions - the UpdatePrestoEngineOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PrestoEngine

      • testLHConsole

        public com.ibm.cloud.sdk.core.http.ServiceCall<SuccessReadyResponse> testLHConsole()
        Readiness API. Verify lhconsole server is up and running.
        Returns:
        a ServiceCall with a result of type SuccessReadyResponse

      • listCatalogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogCollection> listCatalogs()
        List all registered catalogs. List all registered catalogs.
        Returns:
        a ServiceCall with a result of type CatalogCollection

      • deleteSchema

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteSchema​(DeleteSchemaOptions deleteSchemaOptions)
        Delete schema. Delete a schema.
        Parameters:
        deleteSchemaOptions - the DeleteSchemaOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listTables

        public com.ibm.cloud.sdk.core.http.ServiceCall<TableCollection> listTables​(ListTablesOptions listTablesOptions)
        List all tables. List all tables in a schema in a catalog for a given engine.
        Parameters:
        listTablesOptions - the ListTablesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TableCollection

      • getTable

        public com.ibm.cloud.sdk.core.http.ServiceCall<Table> getTable​(GetTableOptions getTableOptions)
        Get table details. Get details of a given table in a catalog and schema.
        Parameters:
        getTableOptions - the GetTableOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Table

      • deleteTable

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTable​(DeleteTableOptions deleteTableOptions)
        Delete table. Delete table for a given schema and catalog.
        Parameters:
        deleteTableOptions - the DeleteTableOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateTable

        public com.ibm.cloud.sdk.core.http.ServiceCall<Table> updateTable​(UpdateTableOptions updateTableOptions)
        Rename table. Rename table.
        Parameters:
        updateTableOptions - the UpdateTableOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Table

      • getCatalog

        public com.ibm.cloud.sdk.core.http.ServiceCall<Catalog> getCatalog​(GetCatalogOptions getCatalogOptions)
        Get catalog properties by catalog_id. Get catalog properties of a catalog identified by catalog_id.
        Parameters:
        getCatalogOptions - the GetCatalogOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Catalog

      • deleteCatalog

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteCatalog​(DeleteCatalogOptions deleteCatalogOptions)
        Delete catalog catalog_id. Delete catalog identified by catalog_id.
        Parameters:
        deleteCatalogOptions - the DeleteCatalogOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getMds

        public com.ibm.cloud.sdk.core.http.ServiceCall<Mds> getMds​(GetMdsOptions getMdsOptions)
        Get configuration for mds. Get configuration for metadata service.
        Parameters:
        getMdsOptions - the GetMdsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Mds

      • getMds

        public com.ibm.cloud.sdk.core.http.ServiceCall<Mds> getMds()
        Get configuration for mds. Get configuration for metadata service.
        Returns:
        a ServiceCall with a result of type Mds

      • updateMds

        public com.ibm.cloud.sdk.core.http.ServiceCall<Mds> updateMds​(UpdateMdsOptions updateMdsOptions)
        Enable or disable MDS. Enable or disable MDS.
        Parameters:
        updateMdsOptions - the UpdateMdsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Mds

      • getInstanceConfiguration

        public com.ibm.cloud.sdk.core.http.ServiceCall<WatsonxInstanceDetails> getInstanceConfiguration()
        Get the instane configuration. Gives a list of the various engines and resources present in the instance, along with the details of the instance.
        Returns:
        a ServiceCall with a result of type WatsonxInstanceDetails

      • getEndpoints

        public com.ibm.cloud.sdk.core.http.ServiceCall<EndpointCollection> getEndpoints()
        Get CPG and CAS endpoints. Get CPG and CAS endpoints.
        Returns:
        a ServiceCall with a result of type EndpointCollection

      • listAllSchemas

        public com.ibm.cloud.sdk.core.http.ServiceCall<SchemaResponseCollection> listAllSchemas()
        Get all schemas for a given catalog. List Schemas for a catalog with the given catalog_name.
        Returns:
        a ServiceCall with a result of type SchemaResponseCollection