com.databricks.sdk.service.sql

Class QueryVisualizationsLegacyAPI

java.lang.Object

com.databricks.sdk.service.sql.QueryVisualizationsLegacyAPI

@Generated
public class QueryVisualizationsLegacyAPI
extends Object

This is an evolving API that facilitates the addition and removal of vizualisations from existing queries within the Databricks Workspace. Data structures may change over time.

**Note**: A new version of the Databricks SQL API is now available. Please see the latest version. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

Constructor Summary

Constructors

Constructor and Description
QueryVisualizationsLegacyAPI(ApiClient apiClient) Regular-use constructor
QueryVisualizationsLegacyAPI(QueryVisualizationsLegacyService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
LegacyVisualization	create(CreateQueryVisualizationsLegacyRequest request) Add visualization to a query.
LegacyVisualization	create(String queryId, String typeValue, Object options)
void	delete(DeleteQueryVisualizationsLegacyRequest request) Remove visualization.
void	delete(String id)
QueryVisualizationsLegacyService	impl()
LegacyVisualization	update(LegacyVisualization request) Edit existing visualization.
LegacyVisualization	update(String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryVisualizationsLegacyAPI

public QueryVisualizationsLegacyAPI(ApiClient apiClient)

Regular-use constructor

QueryVisualizationsLegacyAPI

public QueryVisualizationsLegacyAPI(QueryVisualizationsLegacyService mock)

Constructor for mocks

Method Detail

create

public LegacyVisualization create(String queryId,
                                  String typeValue,
                                  Object options)

create

public LegacyVisualization create(CreateQueryVisualizationsLegacyRequest request)

Add visualization to a query.

Creates visualization in the query.

**Note**: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/create instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

delete

public void delete(String id)

delete

public void delete(DeleteQueryVisualizationsLegacyRequest request)

Remove visualization.

Removes a visualization from the query.

**Note**: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/delete instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

update

public LegacyVisualization update(String id)

update

public LegacyVisualization update(LegacyVisualization request)

Edit existing visualization.

Updates visualization in the query.

**Note**: A new version of the Databricks SQL API is now available. Please use :method:queryvisualizations/update instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html

impl

public QueryVisualizationsLegacyService impl()