com.databricks.sdk.service.sql.DataSourcesAPI Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.sql;
import com.databricks.sdk.core.ApiClient;
import com.databricks.sdk.support.Generated;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* This API is provided to assist you in making new query objects. When creating a query object, you
* may optionally specify a `data_source_id` for the SQL warehouse against which it will run. If you
* don't already know the `data_source_id` for your desired SQL warehouse, this API will help you
* find it.
*
* This API does not support searches. It returns the full list of SQL warehouses in your
* workspace. We advise you to use any text editor, REST client, or `grep` to search the response
* from this API for the name of your SQL warehouse as it appears in Databricks SQL.
*
*
**Note**: A new version of the Databricks SQL API is now available. [Learn more]
*
*
[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
*/
@Generated
public class DataSourcesAPI {
private static final Logger LOG = LoggerFactory.getLogger(DataSourcesAPI.class);
private final DataSourcesService impl;
/** Regular-use constructor */
public DataSourcesAPI(ApiClient apiClient) {
impl = new DataSourcesImpl(apiClient);
}
/** Constructor for mocks */
public DataSourcesAPI(DataSourcesService mock) {
impl = mock;
}
/**
* Get a list of SQL warehouses.
*
*
Retrieves a full list of SQL warehouses available in this workspace. All fields that appear
* in this API response are enumerated for clarity. However, you need only a SQL warehouse's `id`
* to create new queries against it.
*
*
**Note**: A new version of the Databricks SQL API is now available. Please use
* :method:warehouses/list instead. [Learn more]
*
*
[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
*/
public Iterable list() {
return impl.list();
}
public DataSourcesService impl() {
return impl;
}
}