| Package | Description |
|---|---|
| com.databricks.sdk | |
| com.databricks.sdk.service.dashboards | |
| com.databricks.sdk.service.sql |
| Class and Description |
|---|
| AlertsAPI
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsLegacyAPI
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsLegacyService
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsService
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsV2API
New version of SQL Alerts
|
| AlertsV2Service
New version of SQL Alerts
|
| DashboardsAPI
In general, there is little need to modify dashboards using the API.
|
| DashboardsService
In general, there is little need to modify dashboards using the API.
|
| DashboardWidgetsAPI
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
| DashboardWidgetsService
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
| DataSourcesAPI
This API is provided to assist you in making new query objects.
|
| DataSourcesService
This API is provided to assist you in making new query objects.
|
| DbsqlPermissionsAPI
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
| DbsqlPermissionsService
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
| QueriesAPI
The queries API can be used to perform CRUD operations on queries.
|
| QueriesLegacyAPI
These endpoints are used for CRUD operations on query definitions.
|
| QueriesLegacyService
These endpoints are used for CRUD operations on query definitions.
|
| QueriesService
The queries API can be used to perform CRUD operations on queries.
|
| QueryHistoryAPI
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
| QueryHistoryService
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
| QueryVisualizationsAPI
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
| QueryVisualizationsLegacyAPI
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
| QueryVisualizationsLegacyService
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
| QueryVisualizationsService
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
| RedashConfigAPI
Redash V2 service for workspace configurations (internal)
|
| RedashConfigService
Redash V2 service for workspace configurations (internal)
|
| StatementExecutionAPI
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
| StatementExecutionService
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
| WarehousesAPI
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| WarehousesService
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| Class and Description |
|---|
| StatementResponse |
| Class and Description |
|---|
| AccessControl |
| Aggregation |
| Alert |
| AlertCondition |
| AlertConditionOperand |
| AlertConditionThreshold |
| AlertEvaluationState
UNSPECIFIED - default unspecify value for proto enum, do not use it in the code UNKNOWN - alert
not yet evaluated TRIGGERED - alert is triggered OK - alert is not triggered ERROR - alert
evaluation failed
|
| AlertOperandColumn |
| AlertOperandValue |
| AlertOperator |
| AlertOptions
Alert configuration options.
|
| AlertOptionsEmptyResultState
State that alert evaluates to when query result is empty.
|
| AlertQuery |
| AlertsLegacyService
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsService
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertState |
| AlertsV2Service
New version of SQL Alerts
|
| AlertV2 |
| AlertV2Evaluation |
| AlertV2Notification |
| AlertV2Operand |
| AlertV2OperandColumn |
| AlertV2OperandValue |
| AlertV2Subscription |
| BaseChunkInfo
Describes metadata for a particular chunk, within a result set; this structure is used both
within a manifest, and when fetching individual chunk data or links.
|
| CancelExecutionRequest
Cancel statement execution
|
| Channel
Configures the channel name and DBSQL version of the warehouse.
|
| ChannelInfo
Details about a Channel.
|
| ChannelName |
| ClientConfig |
| ColumnInfo |
| ColumnInfoTypeName
The name of the base data type.
|
| ComparisonOperator |
| CreateAlert |
| CreateAlertRequest |
| CreateAlertRequestAlert |
| CreateAlertV2Request
Create an alert
|
| CreateQueryRequest |
| CreateQueryRequestQuery |
| CreateQueryVisualizationsLegacyRequest
Add visualization to a query
|
| CreateVisualizationRequest |
| CreateVisualizationRequestVisualization |
| CreateWarehouseRequest |
| CreateWarehouseRequestWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
| CreateWarehouseResponse |
| CreateWidget |
| CronSchedule |
| Dashboard
A JSON representing a dashboard containing widgets of visualizations and text boxes.
|
| DashboardEditContent |
| DashboardOptions |
| DashboardPostContent |
| DashboardsService
In general, there is little need to modify dashboards using the API.
|
| DashboardWidgetsService
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
| DataSource
A JSON object representing a DBSQL data source / SQL warehouse.
|
| DataSourcesService
This API is provided to assist you in making new query objects.
|
| DatePrecision |
| DateRange |
| DateRangeValue |
| DateRangeValueDynamicDateRange |
| DateValue |
| DateValueDynamicDate |
| DbsqlPermissionsService
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
| DeleteAlertsLegacyRequest
Delete an alert
|
| DeleteDashboardRequest
Remove a dashboard
|
| DeleteDashboardWidgetRequest
Remove widget
|
| DeleteQueriesLegacyRequest
Delete a query
|
| DeleteQueryVisualizationsLegacyRequest
Remove visualization
|
| DeleteVisualizationRequest
Remove a visualization
|
| DeleteWarehouseRequest
Delete a warehouse
|
| Disposition |
| EditAlert |
| EditWarehouseRequest |
| EditWarehouseRequestWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
| EndpointConfPair |
| EndpointHealth |
| EndpointInfo |
| EndpointInfoWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
| EndpointTagPair |
| EndpointTags |
| EnumValue |
| ExecuteStatementRequest |
| ExecuteStatementRequestOnWaitTimeout
When `wait_timeout > 0s`, the call will block up to the specified time.
|
| ExternalLink |
| ExternalQuerySource |
| ExternalQuerySourceJobInfo |
| Format |
| GetAlertRequest
Get an alert
|
| GetAlertsLegacyRequest
Get an alert
|
| GetAlertV2Request
Get an alert
|
| GetDashboardRequest
Retrieve a definition
|
| GetDbsqlPermissionRequest
Get object ACL
|
| GetQueriesLegacyRequest
Get a query definition.
|
| GetQueryRequest
Get a query
|
| GetResponse |
| GetStatementRequest
Get status, manifest, and result first chunk
|
| GetStatementResultChunkNRequest
Get result chunk by index
|
| GetWarehousePermissionLevelsRequest
Get SQL warehouse permission levels
|
| GetWarehousePermissionLevelsResponse |
| GetWarehousePermissionsRequest
Get SQL warehouse permissions
|
| GetWarehouseRequest
Get warehouse info
|
| GetWarehouseResponse |
| GetWarehouseResponseWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
| GetWorkspaceWarehouseConfigResponse |
| GetWorkspaceWarehouseConfigResponseSecurityPolicy
Security policy for warehouses
|
| LegacyAlert |
| LegacyAlertState
State of the alert.
|
| LegacyQuery |
| LegacyVisualization
The visualization description API changes frequently and is unsupported.
|
| LifecycleState |
| ListAlertsRequest
List alerts
|
| ListAlertsResponse |
| ListAlertsResponseAlert |
| ListAlertsV2Request
List alerts
|
| ListAlertsV2Response |
| ListDashboardsRequest
Get dashboard objects
|
| ListOrder |
| ListQueriesLegacyRequest
Get a list of queries
|
| ListQueriesRequest
List queries
|
| ListQueriesResponse |
| ListQueryHistoryRequest
List Queries
|
| ListQueryObjectsResponse |
| ListQueryObjectsResponseQuery |
| ListResponse |
| ListVisualizationsForQueryRequest
List visualizations on a query
|
| ListVisualizationsForQueryResponse |
| ListWarehousesRequest
List warehouses
|
| ListWarehousesResponse |
| MultiValuesOptions |
| NumericValue |
| ObjectType
A singular noun object type.
|
| ObjectTypePlural
Always a plural of the object type.
|
| OdbcParams |
| OwnableObjectType
The singular form of the type of object which can be owned.
|
| Parameter |
| ParameterType
Parameters can have several different types.
|
| PermissionLevel
* `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * `CAN_EDIT`: Can edit the query
* `CAN_MANAGE`: Can manage the query
|
| PlansState
Possible Reasons for which we have not saved plans in the database
|
| QueriesLegacyService
These endpoints are used for CRUD operations on query definitions.
|
| QueriesService
The queries API can be used to perform CRUD operations on queries.
|
| Query |
| QueryBackedValue |
| QueryEditContent |
| QueryFilter |
| QueryHistoryService
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
| QueryInfo |
| QueryList |
| QueryMetrics
A query metric that encapsulates a set of measurements for a single query.
|
| QueryOptions |
| QueryParameter |
| QueryPostContent |
| QueryStatementType |
| QueryStatus
Statuses which are also used by OperationStatus in runtime
|
| QueryVisualizationsLegacyService
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
| QueryVisualizationsService
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
| RedashConfigService
Redash V2 service for workspace configurations (internal)
|
| RepeatedEndpointConfPairs |
| RestoreDashboardRequest
Restore a dashboard
|
| RestoreQueriesLegacyRequest
Restore a query
|
| ResultData |
| ResultManifest
The result manifest provides schema and metadata for the result set.
|
| ResultSchema
The schema is an ordered list of column descriptions.
|
| RunAsMode |
| RunAsRole
Sets the **Run as** role for the object.
|
| SchedulePauseStatus |
| ServiceError |
| ServiceErrorCode |
| SetRequest
Set object ACL
|
| SetResponse |
| SetWorkspaceWarehouseConfigRequest |
| SetWorkspaceWarehouseConfigRequestSecurityPolicy
Security policy for warehouses
|
| SpotInstancePolicy
Configurations whether the warehouse should use spot instances.
|
| StartRequest
Start a warehouse
|
| State
State of the warehouse
|
| StatementExecutionService
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
| StatementParameterListItem |
| StatementResponse |
| StatementState
Statement execution state: - `PENDING`: waiting for warehouse - `RUNNING`: running - `SUCCEEDED`:
execution was successful, result data available for fetch - `FAILED`: execution failed; reason
for failure described in accomanying error message - `CANCELED`: user canceled; can come from
explicit cancel call, or timeout with `on_wait_timeout=CANCEL` - `CLOSED`: execution successful,
and statement closed; result no longer available for fetch
|
| StatementStatus
The status response includes execution state and if relevant, error information.
|
| Status
Health status of the warehouse.
|
| StopRequest
Stop a warehouse
|
| Success |
| SuccessMessage |
| TerminationReason |
| TerminationReasonCode
status code indicating why the cluster was terminated
|
| TerminationReasonType
type of the termination
|
| TextValue |
| TimeRange |
| TransferOwnershipObjectId |
| TransferOwnershipRequest
Transfer object ownership
|
| TrashAlertRequest
Delete an alert
|
| TrashAlertV2Request
Delete an alert
|
| TrashQueryRequest
Delete a query
|
| UpdateAlertRequest |
| UpdateAlertRequestAlert |
| UpdateAlertV2Request
Update an alert
|
| UpdateQueryRequest |
| UpdateQueryRequestQuery |
| UpdateVisualizationRequest |
| UpdateVisualizationRequestVisualization |
| User |
| Visualization |
| WarehouseAccessControlRequest |
| WarehouseAccessControlResponse |
| WarehousePermission |
| WarehousePermissionLevel
Permission level
|
| WarehousePermissions |
| WarehousePermissionsDescription |
| WarehousePermissionsRequest |
| WarehousesService
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| WarehouseTypePair |
| WarehouseTypePairWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
| Widget |
| WidgetOptions |
| WidgetPosition
Coordinates of this widget on a dashboard.
|
Copyright © 2025. All rights reserved.