| Modifier and Type | Class and Description |
|---|---|
class |
AccountClient
Entry point for accessing Databricks account-level APIs
|
class |
WorkspaceClient
Entry point for accessing Databricks workspace-level APIs
|
| Modifier and Type | Class and Description |
|---|---|
class |
Aborted
the operation was aborted, typically due to a concurrency issue such as a sequencer check failure
|
class |
AlreadyExists
operation was rejected due a conflict with an existing resource
|
class |
BadRequest
the request is invalid
|
class |
Cancelled
the operation was explicitly canceled by the caller
|
class |
DataLoss
unrecoverable data loss or corruption
|
class |
DeadlineExceeded
the deadline expired before the operation could complete
|
class |
InternalError
some invariants expected by the underlying system have been broken
|
class |
InvalidParameterValue
supplied value for a parameter was invalid
|
class |
InvalidState
unexpected state
|
class |
NotFound
the operation was performed on a resource that does not exist
|
class |
NotImplemented
the operation is not implemented or is not supported/enabled in this service
|
class |
PermissionDenied
the caller does not have permission to execute the specified operation
|
class |
RequestLimitExceeded
cluster request was rejected because it would exceed a resource limit
|
class |
ResourceAlreadyExists
operation was rejected due a conflict with an existing resource
|
class |
ResourceConflict
maps to all HTTP 409 (Conflict) responses
|
class |
ResourceDoesNotExist
operation was performed on a resource that does not exist
|
class |
ResourceExhausted
operation is rejected due to per-user rate limiting
|
class |
TemporarilyUnavailable
the service is currently unavailable
|
class |
TooManyRequests
maps to HTTP code: 429 Too Many Requests
|
class |
Unauthenticated
the request does not have valid authentication (AuthN) credentials for the operation
|
class |
Unknown
this error is used as a fallback if the platform-side mapping is missing some reason
|
| Modifier and Type | Class and Description |
|---|---|
class |
ActionConfiguration |
class |
ActionConfigurationType |
class |
AlertConfiguration |
class |
AlertConfigurationQuantityType |
class |
AlertConfigurationTimePeriod |
class |
AlertConfigurationTriggerType |
class |
BillableUsageAPI
This API allows you to download billable usage logs for the specified account and date range.
|
interface |
BillableUsageService
This API allows you to download billable usage logs for the specified account and date range.
|
class |
BudgetConfiguration |
class |
BudgetConfigurationFilter |
class |
BudgetConfigurationFilterClause |
class |
BudgetConfigurationFilterOperator |
class |
BudgetConfigurationFilterTagClause |
class |
BudgetConfigurationFilterWorkspaceIdClause |
class |
BudgetPolicy
Contains the BudgetPolicy details.
|
class |
BudgetPolicyAPI
A service serves REST API about Budget policies
|
interface |
BudgetPolicyService
A service serves REST API about Budget policies
|
class |
BudgetsAPI
These APIs manage budget configurations for this account.
|
interface |
BudgetsService
These APIs manage budget configurations for this account.
|
class |
CreateBillingUsageDashboardRequest |
class |
CreateBillingUsageDashboardResponse |
class |
CreateBudgetConfigurationBudget |
class |
CreateBudgetConfigurationBudgetActionConfigurations |
class |
CreateBudgetConfigurationBudgetAlertConfigurations |
class |
CreateBudgetConfigurationRequest |
class |
CreateBudgetConfigurationResponse |
class |
CreateBudgetPolicyRequest
A request to create a BudgetPolicy.
|
class |
CreateLogDeliveryConfigurationParams |
class |
DeleteBudgetConfigurationRequest
Delete budget
|
class |
DeleteBudgetConfigurationResponse |
class |
DeleteBudgetPolicyRequest
Delete a budget policy
|
class |
DeleteResponse |
class |
DeliveryStatus
The status string for log delivery.
|
class |
DownloadRequest
Return billable usage logs
|
class |
DownloadResponse |
class |
Filter
Structured representation of a filter to be applied to a list of policies.
|
class |
GetBillingUsageDashboardRequest
Get usage dashboard
|
class |
GetBillingUsageDashboardResponse |
class |
GetBudgetConfigurationRequest
Get budget
|
class |
GetBudgetConfigurationResponse |
class |
GetBudgetPolicyRequest
Get a budget policy
|
class |
GetLogDeliveryRequest
Get log delivery configuration
|
class |
LimitConfig
The limit configuration of the policy.
|
class |
ListBudgetConfigurationsRequest
Get all budgets
|
class |
ListBudgetConfigurationsResponse |
class |
ListBudgetPoliciesRequest
List policies
|
class |
ListBudgetPoliciesResponse
A list of policies.
|
class |
ListLogDeliveryRequest
Get all log delivery configurations
|
class |
LogDeliveryAPI
These APIs manage log delivery configurations for this account.
|
class |
LogDeliveryConfigStatus
Status of log delivery configuration.
|
class |
LogDeliveryConfiguration |
interface |
LogDeliveryService
These APIs manage log delivery configurations for this account.
|
class |
LogDeliveryStatus
Databricks log delivery status.
|
class |
LogType
Log delivery type.
|
class |
OutputFormat
The file type of log delivery.
|
class |
PatchStatusResponse |
class |
SortSpec |
class |
SortSpecField |
class |
UpdateBudgetConfigurationBudget |
class |
UpdateBudgetConfigurationRequest |
class |
UpdateBudgetConfigurationResponse |
class |
UpdateBudgetPolicyRequest
Update a budget policy
|
class |
UpdateLogDeliveryConfigurationStatusRequest |
class |
UsageDashboardsAPI
These APIs manage usage dashboards for this account.
|
interface |
UsageDashboardsService
These APIs manage usage dashboards for this account.
|
class |
UsageDashboardType |
class |
WrappedCreateLogDeliveryConfiguration |
class |
WrappedLogDeliveryConfiguration |
class |
WrappedLogDeliveryConfigurations |
| Modifier and Type | Class and Description |
|---|---|
class |
AccountMetastoreAssignmentsAPI
These APIs manage metastore assignments to a workspace.
|
interface |
AccountMetastoreAssignmentsService
These APIs manage metastore assignments to a workspace.
|
class |
AccountMetastoresAPI
These APIs manage Unity Catalog metastores for an account.
|
interface |
AccountMetastoresService
These APIs manage Unity Catalog metastores for an account.
|
class |
AccountsCreateMetastore |
class |
AccountsCreateMetastoreAssignment |
class |
AccountsCreateStorageCredential |
class |
AccountsMetastoreAssignment |
class |
AccountsMetastoreInfo |
class |
AccountsStorageCredentialInfo |
class |
AccountStorageCredentialsAPI
These APIs manage storage credentials for a particular metastore.
|
interface |
AccountStorageCredentialsService
These APIs manage storage credentials for a particular metastore.
|
class |
AccountsUpdateMetastore |
class |
AccountsUpdateMetastoreAssignment |
class |
AccountsUpdateStorageCredential |
class |
ArtifactAllowlistInfo |
class |
ArtifactAllowlistsAPI
In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist`
in UC so that users can leverage these artifacts on compute configured with shared access mode.
|
interface |
ArtifactAllowlistsService
In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist`
in UC so that users can leverage these artifacts on compute configured with shared access mode.
|
class |
ArtifactMatcher |
class |
ArtifactType
The artifact type
|
class |
AssignResponse |
class |
AwsCredentials
AWS temporary credentials for API authentication.
|
class |
AwsIamRole
The AWS IAM role configuration
|
class |
AwsIamRoleRequest |
class |
AwsIamRoleResponse |
class |
AwsSqsQueue |
class |
AzureActiveDirectoryToken
Azure Active Directory token, essentially the Oauth token for Azure Service Principal or Managed
Identity.
|
class |
AzureManagedIdentity
The Azure managed identity configuration.
|
class |
AzureManagedIdentityRequest |
class |
AzureManagedIdentityResponse |
class |
AzureQueueStorage |
class |
AzureServicePrincipal
The Azure service principal configuration.
|
class |
AzureUserDelegationSas
Azure temporary credentials for API authentication.
|
class |
CancelRefreshRequest
Cancel refresh
|
class |
CancelRefreshResponse |
class |
CatalogInfo |
class |
CatalogIsolationMode |
class |
CatalogsAPI
A catalog is the first layer of Unity Catalog’s three-level namespace.
|
interface |
CatalogsService
A catalog is the first layer of Unity Catalog’s three-level namespace.
|
class |
CatalogType
The type of the catalog.
|
class |
CloudflareApiToken |
class |
ColumnInfo |
class |
ColumnMask |
class |
ColumnTypeName |
class |
ConnectionInfo |
class |
ConnectionsAPI
Connections allow for creating a connection to an external data source.
|
interface |
ConnectionsService
Connections allow for creating a connection to an external data source.
|
class |
ConnectionType
Next Id: 30
|
class |
ContinuousUpdateStatus
Detailed status of an online table.
|
class |
CreateCatalog |
class |
CreateConnection |
class |
CreateCredentialRequest |
class |
CreateDatabaseCatalogRequest
Create a Database Catalog
|
class |
CreateDatabaseInstanceRequest
Create a Database Instance
|
class |
CreateExternalLocation |
class |
CreateFunction |
class |
CreateFunctionParameterStyle
Function parameter style.
|
class |
CreateFunctionRequest |
class |
CreateFunctionRoutineBody
Function language.
|
class |
CreateFunctionSecurityType
The security type of the function.
|
class |
CreateFunctionSqlDataAccess
Function SQL data access.
|
class |
CreateMetastore |
class |
CreateMetastoreAssignment |
class |
CreateMonitor |
class |
CreateOnlineTableRequest
Create an Online Table
|
class |
CreateRegisteredModelRequest |
class |
CreateResponse |
class |
CreateSchema |
class |
CreateStorageCredential |
class |
CreateSyncedDatabaseTableRequest
Create a Synced Database Table
|
class |
CreateTableConstraint |
class |
CreateVolumeRequestContent |
class |
CredentialInfo |
class |
CredentialPurpose |
class |
CredentialsAPI
A credential represents an authentication and authorization mechanism for accessing services on
your cloud tenant.
|
interface |
CredentialsService
A credential represents an authentication and authorization mechanism for accessing services on
your cloud tenant.
|
class |
CredentialType
Next Id: 12
|
class |
CredentialValidationResult |
class |
DatabaseCatalog |
class |
DatabaseInstance
A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.
|
class |
DatabaseInstancesAPI
Database Instances provide access to a database via REST API or direct SQL.
|
interface |
DatabaseInstancesService
Database Instances provide access to a database via REST API or direct SQL.
|
class |
DatabaseInstanceState |
class |
DatabricksGcpServiceAccount
GCP long-lived credential.
|
class |
DatabricksGcpServiceAccountRequest |
class |
DatabricksGcpServiceAccountResponse |
class |
DataSourceFormat
Data source format
|
class |
DeleteAccountMetastoreAssignmentRequest
Delete a metastore assignment
|
class |
DeleteAccountMetastoreRequest
Delete a metastore
|
class |
DeleteAccountStorageCredentialRequest
Delete a storage credential
|
class |
DeleteAliasRequest
Delete a Registered Model Alias
|
class |
DeleteAliasResponse |
class |
DeleteCatalogRequest
Delete a catalog
|
class |
DeleteConnectionRequest
Delete a connection
|
class |
DeleteCredentialRequest
Delete a credential
|
class |
DeleteCredentialResponse |
class |
DeleteDatabaseCatalogRequest
Delete a Database Catalog
|
class |
DeleteDatabaseCatalogResponse |
class |
DeleteDatabaseInstanceRequest
Delete a Database Instance
|
class |
DeleteDatabaseInstanceResponse |
class |
DeleteExternalLocationRequest
Delete an external location
|
class |
DeleteFunctionRequest
Delete a function
|
class |
DeleteMetastoreRequest
Delete a metastore
|
class |
DeleteModelVersionRequest
Delete a Model Version
|
class |
DeleteOnlineTableRequest
Delete an Online Table
|
class |
DeleteQualityMonitorRequest
Delete a table monitor
|
class |
DeleteRegisteredModelRequest
Delete a Registered Model
|
class |
DeleteResponse |
class |
DeleteSchemaRequest
Delete a schema
|
class |
DeleteStorageCredentialRequest
Delete a credential
|
class |
DeleteSyncedDatabaseTableRequest
Delete a Synced Database Table
|
class |
DeleteSyncedDatabaseTableResponse |
class |
DeleteTableConstraintRequest
Delete a table constraint
|
class |
DeleteTableRequest
Delete a table
|
class |
DeleteVolumeRequest
Delete a Volume
|
class |
DeltaRuntimePropertiesKvPairs
Properties pertaining to the current state of the delta table as given by the commit server.
|
class |
Dependency
A dependency of a SQL object.
|
class |
DependencyList
A list of dependencies.
|
class |
DisableRequest
Disable a system schema
|
class |
DisableResponse |
class |
EffectivePermissionsList |
class |
EffectivePredictiveOptimizationFlag |
class |
EffectivePredictiveOptimizationFlagInheritedFromType
The type of the object from which the flag was inherited.
|
class |
EffectivePrivilege |
class |
EffectivePrivilegeAssignment |
class |
EnablePredictiveOptimization |
class |
EnableRequest |
class |
EnableResponse |
class |
EncryptionDetails
Encryption options that apply to clients connecting to cloud storage.
|
class |
ExistsRequest
Get boolean reflecting if table exists
|
class |
ExternalLocationInfo |
class |
ExternalLocationsAPI
An external location is an object that combines a cloud storage path with a storage credential
that authorizes access to the cloud storage path.
|
interface |
ExternalLocationsService
An external location is an object that combines a cloud storage path with a storage credential
that authorizes access to the cloud storage path.
|
class |
FailedStatus
Detailed status of an online table.
|
class |
FileEventQueue |
class |
FindDatabaseInstanceByUidRequest
Find a Database Instance by uid
|
class |
ForeignKeyConstraint |
class |
FunctionDependency
A function that is dependent on a SQL object.
|
class |
FunctionInfo |
class |
FunctionInfoParameterStyle
Function parameter style.
|
class |
FunctionInfoRoutineBody
Function language.
|
class |
FunctionInfoSecurityType
The security type of the function.
|
class |
FunctionInfoSqlDataAccess
Function SQL data access.
|
class |
FunctionParameterInfo |
class |
FunctionParameterInfos |
class |
FunctionParameterMode
The mode of the function parameter.
|
class |
FunctionParameterType
The type of function parameter.
|
class |
FunctionsAPI
Functions implement User-Defined Functions (UDFs) in Unity Catalog.
|
interface |
FunctionsService
Functions implement User-Defined Functions (UDFs) in Unity Catalog.
|
class |
GcpOauthToken
GCP temporary credentials for API authentication.
|
class |
GcpPubsub |
class |
GenerateTemporaryServiceCredentialAzureOptions
The Azure cloud options to customize the requested temporary credential
|
class |
GenerateTemporaryServiceCredentialGcpOptions
The GCP cloud options to customize the requested temporary credential
|
class |
GenerateTemporaryServiceCredentialRequest |
class |
GenerateTemporaryTableCredentialRequest |
class |
GenerateTemporaryTableCredentialResponse |
class |
GetAccountMetastoreAssignmentRequest
Gets the metastore assignment for a workspace
|
class |
GetAccountMetastoreRequest
Get a metastore
|
class |
GetAccountStorageCredentialRequest
Gets the named storage credential
|
class |
GetArtifactAllowlistRequest
Get an artifact allowlist
|
class |
GetBindingsRequest
Get securable workspace bindings
|
class |
GetByAliasRequest
Get Model Version By Alias
|
class |
GetCatalogRequest
Get a catalog
|
class |
GetCatalogWorkspaceBindingsResponse |
class |
GetConnectionRequest
Get a connection
|
class |
GetCredentialRequest
Get a credential
|
class |
GetDatabaseCatalogRequest
Get a Database Catalog
|
class |
GetDatabaseInstanceRequest
Get a Database Instance
|
class |
GetEffectiveRequest
Get effective permissions
|
class |
GetExternalLocationRequest
Get an external location
|
class |
GetFunctionRequest
Get a function
|
class |
GetGrantRequest
Get permissions
|
class |
GetMetastoreRequest
Get a metastore
|
class |
GetMetastoreSummaryResponse |
class |
GetMetastoreSummaryResponseDeltaSharingScope
The scope of Delta Sharing enabled for the metastore.
|
class |
GetModelVersionRequest
Get a Model Version
|
class |
GetOnlineTableRequest
Get an Online Table
|
class |
GetQualityMonitorRequest
Get a table monitor
|
class |
GetQuotaRequest
Get information for a single resource quota.
|
class |
GetQuotaResponse |
class |
GetRefreshRequest
Get refresh
|
class |
GetRegisteredModelRequest
Get a Registered Model
|
class |
GetSchemaRequest
Get a schema
|
class |
GetStorageCredentialRequest
Get a credential
|
class |
GetSyncedDatabaseTableRequest
Get a Synced Database Table
|
class |
GetTableRequest
Get a table
|
class |
GetWorkspaceBindingRequest
Get catalog workspace bindings
|
class |
GetWorkspaceBindingsResponse |
class |
GrantsAPI
In Unity Catalog, data is secure by default.
|
interface |
GrantsService
In Unity Catalog, data is secure by default.
|
class |
IsolationMode |
class |
ListAccountMetastoreAssignmentsRequest
Get all workspaces assigned to a metastore
|
class |
ListAccountMetastoreAssignmentsResponse
The list of workspaces to which the given metastore is assigned.
|
class |
ListAccountStorageCredentialsRequest
Get all storage credentials assigned to a metastore
|
class |
ListAccountStorageCredentialsResponse |
class |
ListCatalogsRequest
List catalogs
|
class |
ListCatalogsResponse |
class |
ListConnectionsRequest
List connections
|
class |
ListConnectionsResponse |
class |
ListCredentialsRequest
List credentials
|
class |
ListCredentialsResponse |
class |
ListDatabaseInstancesRequest
List Database Instances
|
class |
ListDatabaseInstancesResponse |
class |
ListExternalLocationsRequest
List external locations
|
class |
ListExternalLocationsResponse |
class |
ListFunctionsRequest
List functions
|
class |
ListFunctionsResponse |
class |
ListMetastoresResponse |
class |
ListModelVersionsRequest
List Model Versions
|
class |
ListModelVersionsResponse |
class |
ListQuotasRequest
List all resource quotas under a metastore.
|
class |
ListQuotasResponse |
class |
ListRefreshesRequest
List refreshes
|
class |
ListRegisteredModelsRequest
List Registered Models
|
class |
ListRegisteredModelsResponse |
class |
ListSchemasRequest
List schemas
|
class |
ListSchemasResponse |
class |
ListStorageCredentialsRequest
List credentials
|
class |
ListStorageCredentialsResponse |
class |
ListSummariesRequest
List table summaries
|
class |
ListSystemSchemasRequest
List system schemas
|
class |
ListSystemSchemasResponse |
class |
ListTablesRequest
List tables
|
class |
ListTablesResponse |
class |
ListTableSummariesResponse |
class |
ListVolumesRequest
List Volumes
|
class |
ListVolumesResponseContent |
class |
MatchType
The artifact pattern matching type
|
class |
MetastoreAssignment |
class |
MetastoreInfo |
class |
MetastoreInfoDeltaSharingScope
The scope of Delta Sharing enabled for the metastore.
|
class |
MetastoresAPI
A metastore is the top-level container of objects in Unity Catalog.
|
interface |
MetastoresService
A metastore is the top-level container of objects in Unity Catalog.
|
class |
ModelVersionInfo |
class |
ModelVersionInfoStatus
Current status of the model version.
|
class |
ModelVersionsAPI
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
interface |
ModelVersionsService
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
class |
MonitorCronSchedule |
class |
MonitorCronSchedulePauseStatus
Read only field that indicates whether a schedule is paused or not.
|
class |
MonitorDataClassificationConfig |
class |
MonitorDestination |
class |
MonitorInferenceLog |
class |
MonitorInferenceLogProblemType
Problem type the model aims to solve.
|
class |
MonitorInfo |
class |
MonitorInfoStatus
The status of the monitor.
|
class |
MonitorMetric |
class |
MonitorMetricType
Can only be one of ``"CUSTOM_METRIC_TYPE_AGGREGATE"``, ``"CUSTOM_METRIC_TYPE_DERIVED"``, or
``"CUSTOM_METRIC_TYPE_DRIFT"``.
|
class |
MonitorNotifications |
class |
MonitorRefreshInfo |
class |
MonitorRefreshInfoState
The current state of the refresh.
|
class |
MonitorRefreshInfoTrigger
The method by which the refresh was triggered.
|
class |
MonitorRefreshListResponse |
class |
MonitorSnapshot |
class |
MonitorTimeSeries |
class |
NamedTableConstraint |
class |
NewPipelineSpec
Custom fields that user can set for pipeline while creating SyncedDatabaseTable.
|
class |
OnlineTable
Online Table information.
|
class |
OnlineTablesAPI
Online tables provide lower latency and higher QPS access to data from Delta tables.
|
class |
OnlineTableSpec
Specification of an online table.
|
class |
OnlineTableSpecContinuousSchedulingPolicy |
class |
OnlineTableSpecTriggeredSchedulingPolicy |
interface |
OnlineTablesService
Online tables provide lower latency and higher QPS access to data from Delta tables.
|
class |
OnlineTableState
The state of an online table.
|
class |
OnlineTableStatus
Status of an online table.
|
class |
PermissionsChange |
class |
PermissionsList |
class |
PipelineProgress
Progress information of the Online Table data synchronization pipeline.
|
class |
PrimaryKeyConstraint |
class |
Privilege |
class |
PrivilegeAssignment |
class |
ProvisioningInfo
Status of an asynchronously provisioned resource.
|
class |
ProvisioningInfoState |
class |
ProvisioningStatus
Detailed status of an online table.
|
class |
QualityMonitorsAPI
A monitor computes and monitors data or model quality metrics for a table over time.
|
interface |
QualityMonitorsService
A monitor computes and monitors data or model quality metrics for a table over time.
|
class |
QuotaInfo |
class |
R2Credentials
R2 temporary credentials for API authentication.
|
class |
ReadVolumeRequest
Get a Volume
|
class |
RegenerateDashboardRequest |
class |
RegenerateDashboardResponse |
class |
RegisteredModelAlias
Registered model alias.
|
class |
RegisteredModelInfo |
class |
RegisteredModelsAPI
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
interface |
RegisteredModelsService
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
class |
ResourceQuotasAPI
Unity Catalog enforces resource quotas on all securable objects, which limits the number of
resources that can be created.
|
interface |
ResourceQuotasService
Unity Catalog enforces resource quotas on all securable objects, which limits the number of
resources that can be created.
|
class |
RunRefreshRequest
Queue a metric refresh for a monitor
|
class |
SchemaInfo
Next ID: 40
|
class |
SchemasAPI
A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
|
interface |
SchemasService
A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
|
class |
SecurableType
The type of Unity Catalog securable.
|
class |
SetArtifactAllowlist |
class |
SetRegisteredModelAliasRequest |
class |
SseEncryptionDetails
Server-Side Encryption properties for clients communicating with AWS s3.
|
class |
SseEncryptionDetailsAlgorithm |
class |
StorageCredentialInfo |
class |
StorageCredentialsAPI
A storage credential represents an authentication and authorization mechanism for accessing data
stored on your cloud tenant.
|
interface |
StorageCredentialsService
A storage credential represents an authentication and authorization mechanism for accessing data
stored on your cloud tenant.
|
class |
SyncedDatabaseTable
Next field marker: 10
|
class |
SyncedTableSchedulingPolicy |
class |
SyncedTableSpec
Specification of a synced database table.
|
class |
SystemSchemaInfo |
class |
SystemSchemasAPI
A system schema is a schema that lives within the system catalog.
|
interface |
SystemSchemasService
A system schema is a schema that lives within the system catalog.
|
class |
TableConstraint
A table constraint, as defined by *one* of the following fields being set:
__primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.
|
class |
TableConstraintsAPI
Primary key and foreign key constraints encode relationships between fields in tables.
|
interface |
TableConstraintsService
Primary key and foreign key constraints encode relationships between fields in tables.
|
class |
TableDependency
A table that is dependent on a SQL object.
|
class |
TableExistsResponse |
class |
TableInfo |
class |
TableOperation |
class |
TableRowFilter |
class |
TablesAPI
A table resides in the third layer of Unity Catalog’s three-level namespace.
|
interface |
TablesService
A table resides in the third layer of Unity Catalog’s three-level namespace.
|
class |
TableSummary |
class |
TableType |
class |
TagKeyValue |
class |
TemporaryCredentials |
class |
TemporaryTableCredentialsAPI
Temporary Table Credentials refer to short-lived, downscoped credentials used to access cloud
storage locationswhere table data is stored in Databricks.
|
interface |
TemporaryTableCredentialsService
Temporary Table Credentials refer to short-lived, downscoped credentials used to access cloud
storage locationswhere table data is stored in Databricks.
|
class |
TriggeredUpdateStatus
Detailed status of an online table.
|
class |
UnassignRequest
Delete an assignment
|
class |
UnassignResponse |
class |
UpdateAssignmentResponse |
class |
UpdateCatalog |
class |
UpdateCatalogWorkspaceBindingsResponse |
class |
UpdateConnection |
class |
UpdateCredentialRequest |
class |
UpdateDatabaseInstanceRequest
Update a Database Instance
|
class |
UpdateExternalLocation |
class |
UpdateFunction |
class |
UpdateMetastore |
class |
UpdateMetastoreAssignment |
class |
UpdateMetastoreDeltaSharingScope
The scope of Delta Sharing enabled for the metastore.
|
class |
UpdateModelVersionRequest |
class |
UpdateMonitor |
class |
UpdatePermissions |
class |
UpdateRegisteredModelRequest |
class |
UpdateResponse |
class |
UpdateSchema |
class |
UpdateStorageCredential |
class |
UpdateTableRequest
Update a table owner.
|
class |
UpdateVolumeRequestContent |
class |
UpdateWorkspaceBindings |
class |
UpdateWorkspaceBindingsParameters |
class |
UpdateWorkspaceBindingsResponse
A list of workspace IDs that are bound to the securable
|
class |
ValidateCredentialRequest
Next ID: 17
|
class |
ValidateCredentialResponse |
class |
ValidateCredentialResult
A enum represents the result of the file operation
|
class |
ValidateStorageCredential |
class |
ValidateStorageCredentialResponse |
class |
ValidationResult |
class |
ValidationResultOperation
The operation tested.
|
class |
ValidationResultResult
The results of the tested operation.
|
class |
VolumeInfo |
class |
VolumesAPI
Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and
processing files.
|
interface |
VolumesService
Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and
processing files.
|
class |
VolumeType
The type of the volume.
|
class |
WorkspaceBinding |
class |
WorkspaceBindingBindingType
Using `BINDING_TYPE_` prefix here to avoid conflict with `TableOperation` enum in
`credentials_common.proto`.
|
class |
WorkspaceBindingsAPI
A securable in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
interface |
WorkspaceBindingsService
A securable in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CleanRoom |
class |
CleanRoomAccessRestricted |
class |
CleanRoomAsset
Metadata of the clean room asset
|
class |
CleanRoomAssetAssetType |
class |
CleanRoomAssetForeignTable |
class |
CleanRoomAssetForeignTableLocalDetails |
class |
CleanRoomAssetNotebook |
class |
CleanRoomAssetsAPI
Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared with
the clean room.
|
interface |
CleanRoomAssetsService
Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared with
the clean room.
|
class |
CleanRoomAssetStatusEnum |
class |
CleanRoomAssetTable |
class |
CleanRoomAssetTableLocalDetails |
class |
CleanRoomAssetView |
class |
CleanRoomAssetViewLocalDetails |
class |
CleanRoomAssetVolumeLocalDetails |
class |
CleanRoomCollaborator
Publicly visible clean room collaborator.
|
class |
CleanRoomNotebookReview |
class |
CleanRoomNotebookReviewNotebookReviewState |
class |
CleanRoomNotebookReviewNotebookReviewSubReason |
class |
CleanRoomNotebookTaskRun
Stores information about a single task run.
|
class |
CleanRoomOutputCatalog |
class |
CleanRoomOutputCatalogOutputCatalogStatus |
class |
CleanRoomRemoteDetail
Publicly visible central clean room details.
|
class |
CleanRoomsAPI
A clean room uses Delta Sharing and serverless compute to provide a secure and privacy-protecting
environment where multiple parties can work together on sensitive enterprise data without direct
access to each other’s data.
|
interface |
CleanRoomsService
A clean room uses Delta Sharing and serverless compute to provide a secure and privacy-protecting
environment where multiple parties can work together on sensitive enterprise data without direct
access to each other’s data.
|
class |
CleanRoomStatusEnum |
class |
CleanRoomTaskRunsAPI
Clean room task runs are the executions of notebooks in a clean room.
|
interface |
CleanRoomTaskRunsService
Clean room task runs are the executions of notebooks in a clean room.
|
class |
CollaboratorJobRunInfo |
class |
ComplianceSecurityProfile
The compliance security profile used to process regulated data following compliance standards.
|
class |
CreateCleanRoomAssetRequest
Create an asset
|
class |
CreateCleanRoomOutputCatalogRequest
Create an output catalog
|
class |
CreateCleanRoomOutputCatalogResponse |
class |
CreateCleanRoomRequest
Create a clean room
|
class |
DeleteCleanRoomAssetRequest
Delete an asset
|
class |
DeleteCleanRoomAssetResponse
Response for delete clean room request.
|
class |
DeleteCleanRoomRequest
Delete a clean room
|
class |
DeleteResponse |
class |
GetCleanRoomAssetRequest
Get an asset
|
class |
GetCleanRoomRequest
Get a clean room
|
class |
ListCleanRoomAssetsRequest
List assets
|
class |
ListCleanRoomAssetsResponse |
class |
ListCleanRoomNotebookTaskRunsRequest
List notebook task runs
|
class |
ListCleanRoomNotebookTaskRunsResponse |
class |
ListCleanRoomsRequest
List clean rooms
|
class |
ListCleanRoomsResponse |
class |
UpdateCleanRoomAssetRequest
Update an asset
|
class |
UpdateCleanRoomRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
AddInstanceProfile |
class |
AddResponse |
class |
Adlsgen2Info
A storage location in Adls Gen2
|
class |
AutoScale |
class |
AwsAttributes
Attributes set during cluster creation which are related to Amazon Web Services.
|
class |
AwsAvailability
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
class |
AzureAttributes
Attributes set during cluster creation which are related to Microsoft Azure.
|
class |
AzureAvailability
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
class |
CancelCommand |
class |
CancelResponse |
class |
ChangeClusterOwner |
class |
ChangeClusterOwnerResponse |
class |
ClientsTypes |
class |
CloneCluster |
class |
CloudProviderNodeInfo |
class |
CloudProviderNodeStatus |
class |
ClusterAccessControlRequest |
class |
ClusterAccessControlResponse |
class |
ClusterAttributes
Common set of attributes set during cluster creation.
|
class |
ClusterCompliance |
class |
ClusterDetails
Describes all of the metadata about a single Spark cluster in Databricks.
|
class |
ClusterEvent |
class |
ClusterLibraryStatuses |
class |
ClusterLogConf
Cluster log delivery config
|
class |
ClusterPermission |
class |
ClusterPermissionLevel
Permission level
|
class |
ClusterPermissions |
class |
ClusterPermissionsDescription |
class |
ClusterPermissionsRequest |
class |
ClusterPoliciesAPI
You can use cluster policies to control users' ability to configure clusters based on a set of
rules.
|
interface |
ClusterPoliciesService
You can use cluster policies to control users' ability to configure clusters based on a set of
rules.
|
class |
ClusterPolicyAccessControlRequest |
class |
ClusterPolicyAccessControlResponse |
class |
ClusterPolicyPermission |
class |
ClusterPolicyPermissionLevel
Permission level
|
class |
ClusterPolicyPermissions |
class |
ClusterPolicyPermissionsDescription |
class |
ClusterPolicyPermissionsRequest |
class |
ClustersAPI
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
class |
ClusterSettingsChange
Represents a change to the cluster settings required for the cluster to become compliant with its
policy.
|
class |
ClusterSize |
class |
ClusterSource
Determines whether the cluster was created by a user through the UI, created by the Databricks
Jobs Scheduler, or through an API request.
|
class |
ClusterSpec
Contains a snapshot of the latest user specified settings that were used to create/edit the
cluster.
|
interface |
ClustersService
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
class |
ClusterStatus
Get status
|
class |
Command |
class |
CommandExecutionAPI
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
|
interface |
CommandExecutionService
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
|
class |
CommandStatus |
class |
CommandStatusRequest
Get command info
|
class |
CommandStatusResponse |
class |
ContextStatus |
class |
ContextStatusRequest
Get status
|
class |
ContextStatusResponse |
class |
CreateCluster |
class |
CreateClusterResponse |
class |
CreateContext |
class |
Created |
class |
CreateInstancePool |
class |
CreateInstancePoolResponse |
class |
CreatePolicy |
class |
CreatePolicyResponse |
class |
CreateResponse |
class |
CustomPolicyTag |
class |
DataPlaneEventDetails |
class |
DataPlaneEventDetailsEventType |
class |
DataSecurityMode
Data security mode decides what data governance model to use when accessing data from a cluster.
|
class |
DbfsStorageInfo
A storage location in DBFS
|
class |
DeleteCluster |
class |
DeleteClusterResponse |
class |
DeleteGlobalInitScriptRequest
Delete init script
|
class |
DeleteInstancePool |
class |
DeleteInstancePoolResponse |
class |
DeletePolicy |
class |
DeletePolicyResponse |
class |
DeleteResponse |
class |
DestroyContext |
class |
DestroyResponse |
class |
DiskSpec
Describes the disks that are launched for each instance in the spark cluster.
|
class |
DiskType
Describes the disk type.
|
class |
DiskTypeAzureDiskVolumeType
All Azure Disk types that Databricks supports.
|
class |
DiskTypeEbsVolumeType
All EBS volume types that Databricks supports.
|
class |
DockerBasicAuth |
class |
DockerImage |
class |
EbsVolumeType
All EBS volume types that Databricks supports.
|
class |
EditCluster |
class |
EditClusterResponse |
class |
EditInstancePool |
class |
EditInstancePoolResponse |
class |
EditPolicy |
class |
EditPolicyResponse |
class |
EditResponse |
class |
EnforceClusterComplianceRequest |
class |
EnforceClusterComplianceResponse |
class |
Environment
The environment entity used to preserve serverless environment side panel, jobs' environment for
non-notebook task, and DLT's environment for classic and serverless pipelines.
|
class |
EventDetails |
class |
EventDetailsCause
The cause of a change in target size.
|
class |
EventType |
class |
GcpAttributes
Attributes set during cluster creation which are related to GCP.
|
class |
GcpAvailability
This field determines whether the instance pool will contain preemptible VMs, on-demand VMs, or
preemptible VMs with a fallback to on-demand VMs if the former is unavailable.
|
class |
GcsStorageInfo
A storage location in Google Cloud Platform's GCS
|
class |
GetClusterComplianceRequest
Get cluster policy compliance
|
class |
GetClusterComplianceResponse |
class |
GetClusterPermissionLevelsRequest
Get cluster permission levels
|
class |
GetClusterPermissionLevelsResponse |
class |
GetClusterPermissionsRequest
Get cluster permissions
|
class |
GetClusterPolicyPermissionLevelsRequest
Get cluster policy permission levels
|
class |
GetClusterPolicyPermissionLevelsResponse |
class |
GetClusterPolicyPermissionsRequest
Get cluster policy permissions
|
class |
GetClusterPolicyRequest
Get a cluster policy
|
class |
GetClusterRequest
Get cluster info
|
class |
GetEvents |
class |
GetEventsOrder |
class |
GetEventsResponse |
class |
GetGlobalInitScriptRequest
Get an init script
|
class |
GetInstancePool |
class |
GetInstancePoolPermissionLevelsRequest
Get instance pool permission levels
|
class |
GetInstancePoolPermissionLevelsResponse |
class |
GetInstancePoolPermissionsRequest
Get instance pool permissions
|
class |
GetInstancePoolRequest
Get instance pool information
|
class |
GetPolicyFamilyRequest
Get policy family information
|
class |
GetSparkVersionsResponse |
class |
GlobalInitScriptCreateRequest |
class |
GlobalInitScriptDetails |
class |
GlobalInitScriptDetailsWithContent |
class |
GlobalInitScriptsAPI
The Global Init Scripts API enables Workspace administrators to configure global initialization
scripts for their workspace.
|
interface |
GlobalInitScriptsService
The Global Init Scripts API enables Workspace administrators to configure global initialization
scripts for their workspace.
|
class |
GlobalInitScriptUpdateRequest |
class |
InitScriptEventDetails |
class |
InitScriptExecutionDetailsInitScriptExecutionStatus
Result of attempted script execution
|
class |
InitScriptInfo
Config for an individual init script Next ID: 11
|
class |
InitScriptInfoAndExecutionDetails |
class |
InstallLibraries |
class |
InstallLibrariesResponse |
class |
InstancePoolAccessControlRequest |
class |
InstancePoolAccessControlResponse |
class |
InstancePoolAndStats |
class |
InstancePoolAwsAttributes
Attributes set during instance pool creation which are related to Amazon Web Services.
|
class |
InstancePoolAwsAttributesAvailability
The set of AWS availability types supported when setting up nodes for a cluster.
|
class |
InstancePoolAzureAttributes
Attributes set during instance pool creation which are related to Azure.
|
class |
InstancePoolAzureAttributesAvailability
The set of Azure availability types supported when setting up nodes for a cluster.
|
class |
InstancePoolGcpAttributes
Attributes set during instance pool creation which are related to GCP.
|
class |
InstancePoolPermission |
class |
InstancePoolPermissionLevel
Permission level
|
class |
InstancePoolPermissions |
class |
InstancePoolPermissionsDescription |
class |
InstancePoolPermissionsRequest |
class |
InstancePoolsAPI
Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use
cloud instances which reduces a cluster start and auto-scaling times.
|
interface |
InstancePoolsService
Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use
cloud instances which reduces a cluster start and auto-scaling times.
|
class |
InstancePoolState
The state of a Cluster.
|
class |
InstancePoolStats |
class |
InstancePoolStatus |
class |
InstanceProfile |
class |
InstanceProfilesAPI
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
interface |
InstanceProfilesService
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
class |
Kind
The kind of compute described by this compute specification.
|
class |
Language |
class |
LibrariesAPI
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
interface |
LibrariesService
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
class |
Library |
class |
LibraryFullStatus
The status of the library on a specific cluster.
|
class |
LibraryInstallStatus
The status of a library on a specific cluster.
|
class |
ListAllClusterLibraryStatusesResponse |
class |
ListAvailableZonesResponse |
class |
ListClusterCompliancesRequest
List cluster policy compliance
|
class |
ListClusterCompliancesResponse |
class |
ListClusterPoliciesRequest
List cluster policies
|
class |
ListClustersFilterBy |
class |
ListClustersRequest
List clusters
|
class |
ListClustersResponse |
class |
ListClustersSortBy |
class |
ListClustersSortByDirection |
class |
ListClustersSortByField |
class |
ListGlobalInitScriptsResponse |
class |
ListInstancePools |
class |
ListInstanceProfilesResponse |
class |
ListNodeTypesResponse |
class |
ListPoliciesResponse |
class |
ListPolicyFamiliesRequest
List policy families
|
class |
ListPolicyFamiliesResponse |
class |
ListSortColumn |
class |
ListSortOrder |
class |
LocalFileInfo |
class |
LogAnalyticsInfo |
class |
LogSyncStatus
The log delivery status
|
class |
MavenLibrary |
class |
NodeInstanceType
This structure embodies the machine type that hosts spark containers Note: this should be an
internal data structure for now It is defined in proto in case we want to send it over the wire
in the future (which is likely)
|
class |
NodeType
A description of a Spark node type including both the dimensions of the node and the instance
type on which it will be hosted.
|
class |
PendingInstanceError
Error message of a failed pending instances
|
class |
PermanentDeleteCluster |
class |
PermanentDeleteClusterResponse |
class |
PinCluster |
class |
PinClusterResponse |
class |
Policy
Describes a Cluster Policy entity.
|
class |
PolicyComplianceForClustersAPI
The policy compliance APIs allow you to view and manage the policy compliance status of clusters
in your workspace.
|
interface |
PolicyComplianceForClustersService
The policy compliance APIs allow you to view and manage the policy compliance status of clusters
in your workspace.
|
class |
PolicyFamiliesAPI
View available policy families.
|
interface |
PolicyFamiliesService
View available policy families.
|
class |
PolicyFamily |
class |
PythonPyPiLibrary |
class |
RCranLibrary |
class |
RemoveInstanceProfile |
class |
RemoveResponse |
class |
ResizeCluster |
class |
ResizeClusterResponse |
class |
RestartCluster |
class |
RestartClusterResponse |
class |
Results |
class |
ResultType |
class |
RuntimeEngine |
class |
S3StorageInfo
A storage location in Amazon S3
|
class |
SparkNode
Describes a specific Spark driver or executor.
|
class |
SparkNodeAwsAttributes
Attributes specific to AWS for a Spark node.
|
class |
SparkVersion |
class |
StartCluster |
class |
StartClusterResponse |
class |
State
The state of a Cluster.
|
class |
TerminationReason |
class |
TerminationReasonCode
The status code indicating why the cluster was terminated
|
class |
TerminationReasonType
type of the termination
|
class |
UninstallLibraries |
class |
UninstallLibrariesResponse |
class |
UnpinCluster |
class |
UnpinClusterResponse |
class |
UpdateCluster |
class |
UpdateClusterResource |
class |
UpdateClusterResponse |
class |
UpdateResponse |
class |
VolumesStorageInfo
A storage location back by UC Volumes.
|
class |
WorkloadType
Cluster Attributes showing for clusters workload types.
|
class |
WorkspaceStorageInfo
A storage location in Workspace Filesystem (WSFS)
|
| Modifier and Type | Class and Description |
|---|---|
class |
AuthorizationDetails |
class |
AuthorizationDetailsGrantRule |
class |
CancelPublishedQueryExecutionRequest
Cancel the results for the a query for a published, embedded dashboard
|
class |
CancelQueryExecutionResponse |
class |
CancelQueryExecutionResponseStatus |
class |
CreateDashboardRequest
Create dashboard
|
class |
CreateScheduleRequest
Create dashboard schedule
|
class |
CreateSubscriptionRequest
Create schedule subscription
|
class |
CronSchedule |
class |
Dashboard |
class |
DashboardView |
class |
DeleteScheduleRequest
Delete dashboard schedule
|
class |
DeleteScheduleResponse |
class |
DeleteSubscriptionRequest
Delete schedule subscription
|
class |
DeleteSubscriptionResponse |
class |
Empty
Represents an empty message, similar to google.protobuf.Empty, which is not available in the firm
right now.
|
class |
ExecutePublishedDashboardQueryRequest
Execute query request for published Dashboards.
|
class |
ExecuteQueryResponse |
class |
GenieAPI
Genie provides a no-code experience for business users, powered by AI/BI.
|
class |
GenieAttachment
Genie AI Response
|
class |
GenieConversation |
class |
GenieCreateConversationMessageRequest |
class |
GenieExecuteMessageAttachmentQueryRequest
Execute message attachment SQL query
|
class |
GenieExecuteMessageQueryRequest
[Deprecated] Execute SQL query in a conversation message
|
class |
GenieGenerateDownloadFullQueryResultRequest
Generate full query result download
|
class |
GenieGenerateDownloadFullQueryResultResponse |
class |
GenieGetConversationMessageRequest
Get conversation message
|
class |
GenieGetDownloadFullQueryResultRequest
Get download full query result
|
class |
GenieGetDownloadFullQueryResultResponse |
class |
GenieGetMessageAttachmentQueryResultRequest
Get message attachment SQL query result
|
class |
GenieGetMessageQueryResultRequest
[Deprecated] Get conversation message SQL query result
|
class |
GenieGetMessageQueryResultResponse |
class |
GenieGetQueryResultByAttachmentRequest
[Deprecated] Get conversation message SQL query result
|
class |
GenieGetSpaceRequest
Get Genie Space
|
class |
GenieMessage |
class |
GenieQueryAttachment |
class |
GenieResultMetadata |
interface |
GenieService
Genie provides a no-code experience for business users, powered by AI/BI.
|
class |
GenieSpace |
class |
GenieStartConversationMessageRequest |
class |
GenieStartConversationResponse |
class |
GetDashboardRequest
Get dashboard
|
class |
GetPublishedDashboardEmbeddedRequest
Read a published dashboard in an embedded ui.
|
class |
GetPublishedDashboardEmbeddedResponse |
class |
GetPublishedDashboardRequest
Get published dashboard
|
class |
GetPublishedDashboardTokenInfoRequest
Read an information of a published dashboard to mint an OAuth token.
|
class |
GetPublishedDashboardTokenInfoResponse |
class |
GetScheduleRequest
Get dashboard schedule
|
class |
GetSubscriptionRequest
Get schedule subscription
|
class |
LakeviewAPI
These APIs provide specific management operations for Lakeview dashboards.
|
class |
LakeviewEmbeddedAPI
Token-based Lakeview APIs for embedding dashboards in external applications.
|
interface |
LakeviewEmbeddedService
Token-based Lakeview APIs for embedding dashboards in external applications.
|
interface |
LakeviewService
These APIs provide specific management operations for Lakeview dashboards.
|
class |
LifecycleState |
class |
ListDashboardsRequest
List dashboards
|
class |
ListDashboardsResponse |
class |
ListSchedulesRequest
List dashboard schedules
|
class |
ListSchedulesResponse |
class |
ListSubscriptionsRequest
List schedule subscriptions
|
class |
ListSubscriptionsResponse |
class |
MessageError |
class |
MessageErrorType |
class |
MessageStatus
MessageStatus.
|
class |
MigrateDashboardRequest |
class |
PendingStatus |
class |
PollPublishedQueryStatusRequest
Poll the results for the a query for a published, embedded dashboard
|
class |
PollQueryStatusResponse |
class |
PollQueryStatusResponseData |
class |
PublishedDashboard |
class |
PublishRequest |
class |
QueryExecutionAPI
Query execution APIs for AI / BI Dashboards
|
interface |
QueryExecutionService
Query execution APIs for AI / BI Dashboards
|
class |
QueryResponseStatus |
class |
Result |
class |
Schedule |
class |
SchedulePauseStatus |
class |
Subscriber |
class |
Subscription |
class |
SubscriptionSubscriberDestination |
class |
SubscriptionSubscriberUser |
class |
SuccessStatus |
class |
TextAttachment |
class |
TrashDashboardRequest
Trash dashboard
|
class |
TrashDashboardResponse |
class |
UnpublishDashboardRequest
Unpublish dashboard
|
class |
UnpublishDashboardResponse |
class |
UpdateDashboardRequest
Update dashboard
|
class |
UpdateScheduleRequest
Update dashboard schedule
|
| Modifier and Type | Class and Description |
|---|---|
class |
AddBlock |
class |
AddBlockResponse |
class |
Close |
class |
CloseResponse |
class |
Create |
class |
CreateDirectoryRequest
Create a directory
|
class |
CreateDirectoryResponse |
class |
CreateResponse |
class |
DbfsAPI
DBFS API makes it simple to interact with various data sources without having to include a users
credentials every time to read a file.
|
interface |
DbfsService
DBFS API makes it simple to interact with various data sources without having to include a users
credentials every time to read a file.
|
class |
Delete |
class |
DeleteDirectoryRequest
Delete a directory
|
class |
DeleteDirectoryResponse |
class |
DeleteFileRequest
Delete a file
|
class |
DeleteResponse |
class |
DirectoryEntry |
class |
DownloadRequest
Download a file
|
class |
DownloadResponse |
class |
FileInfo |
class |
FilesAPI
The Files API is a standard HTTP API that allows you to read, write, list, and delete files and
directories by referring to their URI.
|
interface |
FilesService
The Files API is a standard HTTP API that allows you to read, write, list, and delete files and
directories by referring to their URI.
|
class |
GetDirectoryMetadataRequest
Get directory metadata
|
class |
GetDirectoryMetadataResponse |
class |
GetMetadataRequest
Get file metadata
|
class |
GetMetadataResponse |
class |
GetStatusRequest
Get the information of a file or directory
|
class |
ListDbfsRequest
List directory contents or file details
|
class |
ListDirectoryContentsRequest
List directory contents
|
class |
ListDirectoryResponse |
class |
ListStatusResponse |
class |
MkDirs |
class |
MkDirsResponse |
class |
Move |
class |
MoveResponse |
class |
Put |
class |
PutResponse |
class |
ReadDbfsRequest
Get the contents of a file
|
class |
ReadResponse |
class |
UploadRequest
Upload a file
|
class |
UploadResponse |
| Modifier and Type | Class and Description |
|---|---|
class |
AccessControlAPI
Rule based Access Control for Databricks Resources.
|
class |
AccessControlRequest |
class |
AccessControlResponse |
interface |
AccessControlService
Rule based Access Control for Databricks Resources.
|
class |
AccountAccessControlAPI
These APIs manage access rules on resources in an account.
|
class |
AccountAccessControlProxyAPI
These APIs manage access rules on resources in an account.
|
interface |
AccountAccessControlProxyService
These APIs manage access rules on resources in an account.
|
interface |
AccountAccessControlService
These APIs manage access rules on resources in an account.
|
class |
AccountGroupsAPI
Groups simplify identity management, making it easier to assign access to Databricks account,
data, and other securable objects.
|
interface |
AccountGroupsService
Groups simplify identity management, making it easier to assign access to Databricks account,
data, and other securable objects.
|
class |
AccountServicePrincipalsAPI
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
interface |
AccountServicePrincipalsService
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
AccountUsersAPI
User identities recognized by Databricks and represented by email addresses.
|
interface |
AccountUsersService
User identities recognized by Databricks and represented by email addresses.
|
class |
Actor
represents an identity trying to access a resource - user or a service principal group can be a
principal of a permission set assignment but an actor is always a user or a service principal
|
class |
CheckPolicyRequest
Check access policy to a resource
|
class |
CheckPolicyResponse |
class |
ComplexValue |
class |
ConsistencyToken |
class |
CurrentUserAPI
This API allows retrieving information about currently authenticated user or service principal.
|
interface |
CurrentUserService
This API allows retrieving information about currently authenticated user or service principal.
|
class |
DeleteAccountGroupRequest
Delete a group.
|
class |
DeleteAccountServicePrincipalRequest
Delete a service principal.
|
class |
DeleteAccountUserRequest
Delete a user.
|
class |
DeleteGroupRequest
Delete a group.
|
class |
DeleteResponse |
class |
DeleteServicePrincipalRequest
Delete a service principal.
|
class |
DeleteUserRequest
Delete a user.
|
class |
DeleteWorkspaceAssignmentRequest
Delete permissions assignment
|
class |
DeleteWorkspacePermissionAssignmentResponse |
class |
GetAccountGroupRequest
Get group details.
|
class |
GetAccountServicePrincipalRequest
Get service principal details.
|
class |
GetAccountUserRequest
Get user details.
|
class |
GetAssignableRolesForResourceRequest
Get assignable roles for a resource
|
class |
GetAssignableRolesForResourceResponse |
class |
GetGroupRequest
Get group details.
|
class |
GetPasswordPermissionLevelsResponse |
class |
GetPermissionLevelsRequest
Get object permission levels
|
class |
GetPermissionLevelsResponse |
class |
GetPermissionRequest
Get object permissions
|
class |
GetRuleSetRequest
Get a rule set
|
class |
GetServicePrincipalRequest
Get service principal details.
|
class |
GetSortOrder |
class |
GetUserRequest
Get user details.
|
class |
GetWorkspaceAssignmentRequest
List workspace permissions
|
class |
GrantRule |
class |
Group |
class |
GroupsAPI
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
class |
GroupSchema |
interface |
GroupsService
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
class |
ListAccountGroupsRequest
List group details.
|
class |
ListAccountServicePrincipalsRequest
List service principals.
|
class |
ListAccountUsersRequest
List users.
|
class |
ListGroupsRequest
List group details.
|
class |
ListGroupsResponse |
class |
ListResponseSchema |
class |
ListServicePrincipalResponse |
class |
ListServicePrincipalsRequest
List service principals.
|
class |
ListSortOrder |
class |
ListUsersRequest
List users.
|
class |
ListUsersResponse |
class |
ListWorkspaceAssignmentRequest
Get permission assignments
|
class |
MigratePermissionsRequest |
class |
MigratePermissionsResponse |
class |
Name |
class |
ObjectPermissions |
class |
PartialUpdate |
class |
PasswordAccessControlRequest |
class |
PasswordAccessControlResponse |
class |
PasswordPermission |
class |
PasswordPermissionLevel
Permission level
|
class |
PasswordPermissions |
class |
PasswordPermissionsDescription |
class |
PasswordPermissionsRequest |
class |
Patch |
class |
PatchOp
Type of patch operation.
|
class |
PatchResponse |
class |
PatchSchema |
class |
Permission |
class |
PermissionAssignment
The output format for existing workspace PermissionAssignment records, which contains some info
for user consumption.
|
class |
PermissionAssignments |
class |
PermissionLevel
Permission level
|
class |
PermissionMigrationAPI
APIs for migrating acl permissions, used only by the ucx tool:
https://github.com/databrickslabs/ucx
|
interface |
PermissionMigrationService
APIs for migrating acl permissions, used only by the ucx tool:
https://github.com/databrickslabs/ucx
|
class |
PermissionOutput |
class |
PermissionsAPI
Permissions API are used to create read, write, edit, update and manage access for various users
on different objects and endpoints.
|
class |
PermissionsDescription |
interface |
PermissionsService
Permissions API are used to create read, write, edit, update and manage access for various users
on different objects and endpoints.
|
class |
PrincipalOutput
Information about the principal assigned to the workspace.
|
class |
RequestAuthzIdentity
Defines the identity to be used for authZ of the request on the server side.
|
class |
ResourceInfo |
class |
ResourceMeta |
class |
Role |
class |
RuleSetResponse |
class |
RuleSetUpdateRequest |
class |
ServicePrincipal |
class |
ServicePrincipalsAPI
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
ServicePrincipalSchema |
interface |
ServicePrincipalsService
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
SetObjectPermissions |
class |
UpdateObjectPermissions |
class |
UpdateResponse |
class |
UpdateRuleSetRequest |
class |
UpdateWorkspaceAssignments |
class |
User |
class |
UsersAPI
User identities recognized by Databricks and represented by email addresses.
|
class |
UserSchema |
interface |
UsersService
User identities recognized by Databricks and represented by email addresses.
|
class |
WorkspaceAssignmentAPI
The Workspace Permission Assignment API allows you to manage workspace permissions for principals
in your account.
|
interface |
WorkspaceAssignmentService
The Workspace Permission Assignment API allows you to manage workspace permissions for principals
in your account.
|
class |
WorkspacePermission |
class |
WorkspacePermissions |
| Modifier and Type | Class and Description |
|---|---|
class |
AuthenticationMethod |
class |
BaseJob |
class |
BaseRun |
class |
CancelAllRuns |
class |
CancelAllRunsResponse |
class |
CancelRun |
class |
CancelRunResponse |
class |
CleanRoomsNotebookTask |
class |
CleanRoomsNotebookTaskCleanRoomsNotebookTaskOutput |
class |
CleanRoomTaskRunLifeCycleState
Copied from elastic-spark-common/api/messages/runs.proto.
|
class |
CleanRoomTaskRunResultState
Copied from elastic-spark-common/api/messages/runs.proto.
|
class |
CleanRoomTaskRunState
Stores the run state of the clean rooms notebook task.
|
class |
ClusterInstance |
class |
ClusterSpec |
class |
ComputeConfig |
class |
Condition |
class |
ConditionTask |
class |
ConditionTaskOp
* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands.
|
class |
Continuous |
class |
CreateJob |
class |
CreateResponse
Job was created successfully
|
class |
CronSchedule |
class |
DashboardPageSnapshot |
class |
DashboardTask
Configures the Lakeview Dashboard job task type.
|
class |
DashboardTaskOutput |
class |
DbtOutput |
class |
DbtTask |
class |
DeleteJob |
class |
DeleteResponse |
class |
DeleteRun |
class |
DeleteRunResponse |
class |
EnforcePolicyComplianceForJobResponseJobClusterSettingsChange
Represents a change to the job cluster's settings that would be required for the job clusters to
become compliant with their policies.
|
class |
EnforcePolicyComplianceRequest |
class |
EnforcePolicyComplianceResponse |
class |
ExportRunOutput
Run was exported successfully.
|
class |
ExportRunRequest
Export and retrieve a job run
|
class |
FileArrivalTriggerConfiguration |
class |
ForEachStats |
class |
ForEachTask |
class |
ForEachTaskErrorMessageStats |
class |
ForEachTaskTaskRunStats |
class |
Format |
class |
GenAiComputeTask |
class |
GetJobPermissionLevelsRequest
Get job permission levels
|
class |
GetJobPermissionLevelsResponse |
class |
GetJobPermissionsRequest
Get job permissions
|
class |
GetJobRequest
Get a single job
|
class |
GetPolicyComplianceRequest
Get job policy compliance
|
class |
GetPolicyComplianceResponse |
class |
GetRunOutputRequest
Get the output for a single run
|
class |
GetRunRequest
Get a single job run
|
class |
GitProvider |
class |
GitSnapshot
Read-only state of the remote repository at the time the job was run.
|
class |
GitSource
An optional specification for a remote Git repository containing the source code used by tasks.
|
class |
Job
Job was retrieved successfully.
|
class |
JobAccessControlRequest |
class |
JobAccessControlResponse |
class |
JobCluster |
class |
JobCompliance |
class |
JobDeployment |
class |
JobDeploymentKind
`BUNDLE`: The job is managed by Databricks Asset Bundle.
|
class |
JobEditMode
Edit mode of the job.
|
class |
JobEmailNotifications |
class |
JobEnvironment |
class |
JobNotificationSettings |
class |
JobParameter |
class |
JobParameterDefinition |
class |
JobPermission |
class |
JobPermissionLevel
Permission level
|
class |
JobPermissions |
class |
JobPermissionsDescription |
class |
JobPermissionsRequest |
class |
JobRunAs
Write-only setting.
|
class |
JobsAPI
The Jobs API allows you to create, edit, and delete jobs.
|
class |
JobSettings |
class |
JobsHealthMetric
Specifies the health metric that is being evaluated for a particular health rule.
|
class |
JobsHealthOperator
Specifies the operator used to compare the health metric value with the specified threshold.
|
class |
JobsHealthRule |
class |
JobsHealthRules
An optional set of health rules that can be defined for this job.
|
class |
JobSource
The source of the job specification in the remote repository when the job is source controlled.
|
class |
JobSourceDirtyState
Dirty state indicates the job is not fully synced with the job specification in the remote
repository.
|
interface |
JobsService
The Jobs API allows you to create, edit, and delete jobs.
|
class |
ListJobComplianceForPolicyResponse |
class |
ListJobComplianceRequest
List job policy compliance
|
class |
ListJobsRequest
List jobs
|
class |
ListJobsResponse
List of jobs was retrieved successfully.
|
class |
ListRunsRequest
List job runs
|
class |
ListRunsResponse
List of runs was retrieved successfully.
|
class |
NotebookOutput |
class |
NotebookTask |
class |
OutputSchemaInfo
Stores the catalog name, schema name, and the output schema expiration time for the clean room
run.
|
class |
PauseStatus |
class |
PerformanceTarget
PerformanceTarget defines how performant (lower latency) or cost efficient the execution of run
on serverless compute should be.
|
class |
PeriodicTriggerConfiguration |
class |
PeriodicTriggerConfigurationTimeUnit |
class |
PipelineParams |
class |
PipelineTask |
class |
PolicyComplianceForJobsAPI
The compliance APIs allow you to view and manage the policy compliance status of jobs in your
workspace.
|
interface |
PolicyComplianceForJobsService
The compliance APIs allow you to view and manage the policy compliance status of jobs in your
workspace.
|
class |
PowerBiModel |
class |
PowerBiTable |
class |
PowerBiTask |
class |
PythonWheelTask |
class |
QueueDetails |
class |
QueueDetailsCodeCode
The reason for queuing the run.
|
class |
QueueSettings |
class |
RepairHistoryItem |
class |
RepairHistoryItemType
The repair history item type.
|
class |
RepairRun |
class |
RepairRunResponse
Run repair was initiated.
|
class |
ResetJob |
class |
ResetResponse |
class |
ResolvedConditionTaskValues |
class |
ResolvedDbtTaskValues |
class |
ResolvedNotebookTaskValues |
class |
ResolvedParamPairValues |
class |
ResolvedPythonWheelTaskValues |
class |
ResolvedRunJobTaskValues |
class |
ResolvedStringParamsValues |
class |
ResolvedValues |
class |
Run
Run was retrieved successfully
|
class |
RunConditionTask |
class |
RunForEachTask |
class |
RunIf
An optional value indicating the condition that determines whether the task should be run once
its dependencies have been completed.
|
class |
RunJobOutput |
class |
RunJobTask |
class |
RunLifeCycleState
A value indicating the run's lifecycle state.
|
class |
RunLifecycleStateV2State
The current state of the run.
|
class |
RunNow |
class |
RunNowResponse
Run was started successfully.
|
class |
RunOutput
Run output was retrieved successfully.
|
class |
RunParameters |
class |
RunResultState
A value indicating the run's result.
|
class |
RunState
The current state of the run.
|
class |
RunStatus
The current status of the run
|
class |
RunTask
Used when outputting a child run, in GetRun or ListRuns.
|
class |
RunType
The type of a run.
|
class |
Source
Optional location type of the SQL file.
|
class |
SparkJarTask |
class |
SparkPythonTask |
class |
SparkSubmitTask |
class |
SqlAlertOutput |
class |
SqlAlertState
The state of the SQL alert.
|
class |
SqlDashboardOutput |
class |
SqlDashboardWidgetOutput |
class |
SqlDashboardWidgetOutputStatus |
class |
SqlOutput |
class |
SqlOutputError |
class |
SqlQueryOutput |
class |
SqlStatementOutput |
class |
SqlTask |
class |
SqlTaskAlert |
class |
SqlTaskDashboard |
class |
SqlTaskFile |
class |
SqlTaskQuery |
class |
SqlTaskSubscription |
class |
StorageMode |
class |
SubmitRun |
class |
SubmitRunResponse
Run was created and started successfully.
|
class |
SubmitTask |
class |
Subscription |
class |
SubscriptionSubscriber |
class |
TableUpdateTriggerConfiguration |
class |
Task |
class |
TaskDependency |
class |
TaskEmailNotifications |
class |
TaskNotificationSettings |
class |
TerminationCodeCode
The code indicates why the run was terminated.
|
class |
TerminationDetails |
class |
TerminationTypeType
* `SUCCESS`: The run terminated without any issues * `INTERNAL_ERROR`: An error occurred in the
Databricks platform.
|
class |
TriggerInfo
Additional details about what triggered the run
|
class |
TriggerSettings |
class |
TriggerType
The type of trigger that fired this run.
|
class |
UpdateJob |
class |
UpdateResponse |
class |
ViewItem |
class |
ViewsToExport
* `CODE`: Code view of the notebook.
|
class |
ViewType
`NOTEBOOK`: Notebook view item.
|
class |
Webhook |
class |
WebhookNotifications |
class |
WidgetErrorDetail |
| Modifier and Type | Class and Description |
|---|---|
class |
AddExchangeForListingRequest |
class |
AddExchangeForListingResponse |
class |
AssetType |
class |
BatchGetListingsRequest
Get one batch of listings.
|
class |
BatchGetListingsResponse |
class |
BatchGetProvidersRequest
Get one batch of providers.
|
class |
BatchGetProvidersResponse |
class |
Category |
class |
ConsumerFulfillmentsAPI
Fulfillments are entities that allow consumers to preview installations.
|
interface |
ConsumerFulfillmentsService
Fulfillments are entities that allow consumers to preview installations.
|
class |
ConsumerInstallationsAPI
Installations are entities that allow consumers to interact with Databricks Marketplace listings.
|
interface |
ConsumerInstallationsService
Installations are entities that allow consumers to interact with Databricks Marketplace listings.
|
class |
ConsumerListingsAPI
Listings are the core entities in the Marketplace.
|
interface |
ConsumerListingsService
Listings are the core entities in the Marketplace.
|
class |
ConsumerPersonalizationRequestsAPI
Personalization Requests allow customers to interact with the individualized Marketplace listing
flow.
|
interface |
ConsumerPersonalizationRequestsService
Personalization Requests allow customers to interact with the individualized Marketplace listing
flow.
|
class |
ConsumerProvidersAPI
Providers are the entities that publish listings to the Marketplace.
|
interface |
ConsumerProvidersService
Providers are the entities that publish listings to the Marketplace.
|
class |
ConsumerTerms |
class |
ContactInfo
contact info for the consumer requesting data or performing a listing installation
|
class |
Cost |
class |
CreateExchangeFilterRequest |
class |
CreateExchangeFilterResponse |
class |
CreateExchangeRequest |
class |
CreateExchangeResponse |
class |
CreateFileRequest |
class |
CreateFileResponse |
class |
CreateInstallationRequest |
class |
CreateListingRequest |
class |
CreateListingResponse |
class |
CreatePersonalizationRequest
Data request messages also creates a lead (maybe)
|
class |
CreatePersonalizationRequestResponse |
class |
CreateProviderRequest |
class |
CreateProviderResponse |
class |
DataRefresh |
class |
DataRefreshInfo |
class |
DeleteExchangeFilterRequest
Delete an exchange filter
|
class |
DeleteExchangeFilterResponse |
class |
DeleteExchangeRequest
Delete an exchange
|
class |
DeleteExchangeResponse |
class |
DeleteFileRequest
Delete a file
|
class |
DeleteFileResponse |
class |
DeleteInstallationRequest
Uninstall from a listing
|
class |
DeleteInstallationResponse |
class |
DeleteListingRequest
Delete a listing
|
class |
DeleteListingResponse |
class |
DeleteProviderRequest
Delete provider
|
class |
DeleteProviderResponse |
class |
DeltaSharingRecipientType |
class |
Exchange |
class |
ExchangeFilter |
class |
ExchangeFilterType |
class |
ExchangeListing |
class |
FileInfo |
class |
FileParent |
class |
FileParentType |
class |
FileStatus |
class |
FulfillmentType |
class |
GetExchangeRequest
Get an exchange
|
class |
GetExchangeResponse |
class |
GetFileRequest
Get a file
|
class |
GetFileResponse |
class |
GetLatestVersionProviderAnalyticsDashboardResponse |
class |
GetListingContentMetadataRequest
Get listing content metadata
|
class |
GetListingContentMetadataResponse |
class |
GetListingRequest
Get listing
|
class |
GetListingResponse |
class |
GetListingsRequest
List listings
|
class |
GetListingsResponse |
class |
GetPersonalizationRequestRequest
Get the personalization request for a listing
|
class |
GetPersonalizationRequestResponse |
class |
GetProviderRequest
Get a provider
|
class |
GetProviderResponse |
class |
Installation |
class |
InstallationDetail |
class |
InstallationStatus |
class |
ListAllInstallationsRequest
List all installations
|
class |
ListAllInstallationsResponse |
class |
ListAllPersonalizationRequestsRequest
List all personalization requests
|
class |
ListAllPersonalizationRequestsResponse |
class |
ListExchangeFiltersRequest
List exchange filters
|
class |
ListExchangeFiltersResponse |
class |
ListExchangesForListingRequest
List exchanges for listing
|
class |
ListExchangesForListingResponse |
class |
ListExchangesRequest
List exchanges
|
class |
ListExchangesResponse |
class |
ListFilesRequest
List files
|
class |
ListFilesResponse |
class |
ListFulfillmentsRequest
List all listing fulfillments
|
class |
ListFulfillmentsResponse |
class |
Listing |
class |
ListingDetail |
class |
ListingFulfillment |
class |
ListingSetting |
class |
ListingShareType |
class |
ListingStatus
Enums
|
class |
ListingSummary |
class |
ListingTag |
class |
ListingTagType |
class |
ListingType |
class |
ListInstallationsRequest
List installations for a listing
|
class |
ListInstallationsResponse |
class |
ListListingsForExchangeRequest
List listings for exchange
|
class |
ListListingsForExchangeResponse |
class |
ListListingsRequest
List listings
|
class |
ListListingsResponse |
class |
ListProviderAnalyticsDashboardResponse |
class |
ListProvidersRequest
List providers
|
class |
ListProvidersResponse |
class |
MarketplaceFileType |
class |
PersonalizationRequest |
class |
PersonalizationRequestStatus |
class |
ProviderAnalyticsDashboard |
class |
ProviderExchangeFiltersAPI
Marketplace exchanges filters curate which groups can access an exchange.
|
interface |
ProviderExchangeFiltersService
Marketplace exchanges filters curate which groups can access an exchange.
|
class |
ProviderExchangesAPI
Marketplace exchanges allow providers to share their listings with a curated set of customers.
|
interface |
ProviderExchangesService
Marketplace exchanges allow providers to share their listings with a curated set of customers.
|
class |
ProviderFilesAPI
Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider
icons.
|
interface |
ProviderFilesService
Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider
icons.
|
class |
ProviderInfo |
class |
ProviderListingsAPI
Listings are the core entities in the Marketplace.
|
interface |
ProviderListingsService
Listings are the core entities in the Marketplace.
|
class |
ProviderPersonalizationRequestsAPI
Personalization requests are an alternate to instantly available listings.
|
interface |
ProviderPersonalizationRequestsService
Personalization requests are an alternate to instantly available listings.
|
class |
ProviderProviderAnalyticsDashboardsAPI
Manage templated analytics solution for providers.
|
interface |
ProviderProviderAnalyticsDashboardsService
Manage templated analytics solution for providers.
|
class |
ProviderProvidersAPI
Providers are entities that manage assets in Marketplace.
|
interface |
ProviderProvidersService
Providers are entities that manage assets in Marketplace.
|
class |
RegionInfo |
class |
RemoveExchangeForListingRequest
Remove an exchange for listing
|
class |
RemoveExchangeForListingResponse |
class |
RepoInfo |
class |
RepoInstallation |
class |
SearchListingsRequest
Search listings
|
class |
SearchListingsResponse |
class |
SharedDataObject |
class |
ShareInfo |
class |
TokenDetail |
class |
TokenInfo |
class |
UpdateExchangeFilterRequest |
class |
UpdateExchangeFilterResponse |
class |
UpdateExchangeRequest |
class |
UpdateExchangeResponse |
class |
UpdateInstallationRequest |
class |
UpdateInstallationResponse |
class |
UpdateListingRequest |
class |
UpdateListingResponse |
class |
UpdatePersonalizationRequestRequest |
class |
UpdatePersonalizationRequestResponse |
class |
UpdateProviderAnalyticsDashboardRequest |
class |
UpdateProviderAnalyticsDashboardResponse |
class |
UpdateProviderRequest |
class |
UpdateProviderResponse |
class |
Visibility |
| Modifier and Type | Class and Description |
|---|---|
class |
AccountFederationPolicyAPI
These APIs manage account federation policies.
|
interface |
AccountFederationPolicyService
These APIs manage account federation policies.
|
class |
CreateAccountFederationPolicyRequest
Create account federation policy
|
class |
CreateCustomAppIntegration |
class |
CreateCustomAppIntegrationOutput |
class |
CreatePublishedAppIntegration |
class |
CreatePublishedAppIntegrationOutput |
class |
CreateServicePrincipalFederationPolicyRequest
Create service principal federation policy
|
class |
CreateServicePrincipalSecretRequest |
class |
CreateServicePrincipalSecretResponse |
class |
CustomAppIntegrationAPI
These APIs enable administrators to manage custom OAuth app integrations, which is required for
adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.
|
interface |
CustomAppIntegrationService
These APIs enable administrators to manage custom OAuth app integrations, which is required for
adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.
|
class |
DeleteAccountFederationPolicyRequest
Delete account federation policy
|
class |
DeleteCustomAppIntegrationOutput |
class |
DeleteCustomAppIntegrationRequest
Delete Custom OAuth App Integration
|
class |
DeletePublishedAppIntegrationOutput |
class |
DeletePublishedAppIntegrationRequest
Delete Published OAuth App Integration
|
class |
DeleteResponse |
class |
DeleteServicePrincipalFederationPolicyRequest
Delete service principal federation policy
|
class |
DeleteServicePrincipalSecretRequest
Delete service principal secret
|
class |
FederationPolicy |
class |
GetAccountFederationPolicyRequest
Get account federation policy
|
class |
GetCustomAppIntegrationOutput |
class |
GetCustomAppIntegrationRequest
Get OAuth Custom App Integration
|
class |
GetCustomAppIntegrationsOutput |
class |
GetPublishedAppIntegrationOutput |
class |
GetPublishedAppIntegrationRequest
Get OAuth Published App Integration
|
class |
GetPublishedAppIntegrationsOutput |
class |
GetPublishedAppsOutput |
class |
GetServicePrincipalFederationPolicyRequest
Get service principal federation policy
|
class |
ListAccountFederationPoliciesRequest
List account federation policies
|
class |
ListCustomAppIntegrationsRequest
Get custom oauth app integrations
|
class |
ListFederationPoliciesResponse |
class |
ListOAuthPublishedAppsRequest
Get all the published OAuth apps
|
class |
ListPublishedAppIntegrationsRequest
Get published oauth app integrations
|
class |
ListServicePrincipalFederationPoliciesRequest
List service principal federation policies
|
class |
ListServicePrincipalSecretsRequest
List service principal secrets
|
class |
ListServicePrincipalSecretsResponse |
class |
OAuthPublishedAppsAPI
These APIs enable administrators to view all the available published OAuth applications in
Databricks.
|
interface |
OAuthPublishedAppsService
These APIs enable administrators to view all the available published OAuth applications in
Databricks.
|
class |
OidcFederationPolicy
Specifies the policy to use for validating OIDC claims in your federated tokens.
|
class |
PublishedAppIntegrationAPI
These APIs enable administrators to manage published OAuth app integrations, which is required
for adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS
cloud.
|
interface |
PublishedAppIntegrationService
These APIs enable administrators to manage published OAuth app integrations, which is required
for adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS
cloud.
|
class |
PublishedAppOutput |
class |
SecretInfo |
class |
ServicePrincipalFederationPolicyAPI
These APIs manage service principal federation policies.
|
interface |
ServicePrincipalFederationPolicyService
These APIs manage service principal federation policies.
|
class |
ServicePrincipalSecretsAPI
These APIs enable administrators to manage service principal secrets.
|
interface |
ServicePrincipalSecretsService
These APIs enable administrators to manage service principal secrets.
|
class |
TokenAccessPolicy |
class |
UpdateAccountFederationPolicyRequest
Update account federation policy
|
class |
UpdateCustomAppIntegration |
class |
UpdateCustomAppIntegrationOutput |
class |
UpdatePublishedAppIntegration |
class |
UpdatePublishedAppIntegrationOutput |
class |
UpdateServicePrincipalFederationPolicyRequest
Update service principal federation policy
|
| Modifier and Type | Class and Description |
|---|---|
class |
CreatePipeline |
class |
CreatePipelineResponse |
class |
CronTrigger |
class |
DataPlaneId |
class |
DayOfWeek
Days of week in which the restart is allowed to happen (within a five-hour window starting at
start_hour).
|
class |
DeletePipelineRequest
Delete a pipeline
|
class |
DeletePipelineResponse |
class |
DeploymentKind
The deployment method that manages the pipeline: - BUNDLE: The pipeline is managed by a
Databricks Asset Bundle.
|
class |
EditPipeline |
class |
EditPipelineResponse |
class |
ErrorDetail |
class |
EventLevel
The severity level of the event.
|
class |
EventLogSpec
Configurable event log parameters.
|
class |
FileLibrary |
class |
Filters |
class |
GetPipelinePermissionLevelsRequest
Get pipeline permission levels
|
class |
GetPipelinePermissionLevelsResponse |
class |
GetPipelinePermissionsRequest
Get pipeline permissions
|
class |
GetPipelineRequest
Get a pipeline
|
class |
GetPipelineResponse |
class |
GetPipelineResponseHealth
The health of a pipeline.
|
class |
GetUpdateRequest
Get a pipeline update
|
class |
GetUpdateResponse |
class |
IngestionConfig |
class |
IngestionGatewayPipelineDefinition |
class |
IngestionPipelineDefinition |
class |
IngestionSourceType |
class |
ListPipelineEventsRequest
List pipeline events
|
class |
ListPipelineEventsResponse |
class |
ListPipelinesRequest
List pipelines
|
class |
ListPipelinesResponse |
class |
ListUpdatesRequest
List pipeline updates
|
class |
ListUpdatesResponse |
class |
ManualTrigger |
class |
MaturityLevel
Maturity level for EventDetails.
|
class |
NotebookLibrary |
class |
Notifications |
class |
Origin |
class |
PathPattern |
class |
PipelineAccessControlRequest |
class |
PipelineAccessControlResponse |
class |
PipelineCluster |
class |
PipelineClusterAutoscale |
class |
PipelineClusterAutoscaleMode
Databricks Enhanced Autoscaling optimizes cluster utilization by automatically allocating cluster
resources based on workload volume, with minimal impact to the data processing latency of your
pipelines.
|
class |
PipelineDeployment |
class |
PipelineEvent |
class |
PipelineLibrary |
class |
PipelinePermission |
class |
PipelinePermissionLevel
Permission level
|
class |
PipelinePermissions |
class |
PipelinePermissionsDescription |
class |
PipelinePermissionsRequest |
class |
PipelinesAPI
The Delta Live Tables API allows you to create, edit, delete, start, and view details about
pipelines.
|
class |
PipelineSpec |
interface |
PipelinesService
The Delta Live Tables API allows you to create, edit, delete, start, and view details about
pipelines.
|
class |
PipelineState
The pipeline state.
|
class |
PipelineStateInfo |
class |
PipelineStateInfoHealth
The health of a pipeline.
|
class |
PipelineTrigger |
class |
ReportSpec |
class |
RestartWindow |
class |
RunAs
Write-only setting, available only in Create/Update calls.
|
class |
SchemaSpec |
class |
Sequencing |
class |
SerializedException |
class |
StackFrame |
class |
StartUpdate |
class |
StartUpdateCause
What triggered this update.
|
class |
StartUpdateResponse |
class |
StopPipelineResponse |
class |
StopRequest
Stop a pipeline
|
class |
TableSpec |
class |
TableSpecificConfig |
class |
TableSpecificConfigScdType
The SCD type to use to ingest the table.
|
class |
UpdateInfo |
class |
UpdateInfoCause
What triggered this update.
|
class |
UpdateInfoState
The update state.
|
class |
UpdateStateInfo |
class |
UpdateStateInfoState
The update state.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsCredentials |
class |
AwsKeyInfo |
class |
AzureWorkspaceInfo |
class |
CloudResourceContainer
The general workspace configurations that are specific to cloud providers.
|
class |
CreateAwsKeyInfo |
class |
CreateCredentialAwsCredentials |
class |
CreateCredentialRequest |
class |
CreateCredentialStsRole |
class |
CreateCustomerManagedKeyRequest |
class |
CreateGcpKeyInfo |
class |
CreateNetworkRequest |
class |
CreateStorageConfigurationRequest |
class |
CreateVpcEndpointRequest |
class |
CreateWorkspaceRequest |
class |
Credential |
class |
CredentialsAPI
These APIs manage credential configurations for this workspace.
|
interface |
CredentialsService
These APIs manage credential configurations for this workspace.
|
class |
CustomerFacingGcpCloudResourceContainer
The general workspace configurations that are specific to Google Cloud.
|
class |
CustomerManagedKey |
class |
DeleteCredentialRequest
Delete credential configuration
|
class |
DeleteEncryptionKeyRequest
Delete encryption key configuration
|
class |
DeleteNetworkRequest
Delete a network configuration
|
class |
DeletePrivateAccesRequest
Delete a private access settings object
|
class |
DeleteResponse |
class |
DeleteStorageRequest
Delete storage configuration
|
class |
DeleteVpcEndpointRequest
Delete VPC endpoint configuration
|
class |
DeleteWorkspaceRequest
Delete a workspace
|
class |
EncryptionKeysAPI
These APIs manage encryption key configurations for this workspace (optional).
|
interface |
EncryptionKeysService
These APIs manage encryption key configurations for this workspace (optional).
|
class |
EndpointUseCase
This enumeration represents the type of Databricks VPC [endpoint service] that was used when
creating this VPC endpoint.
|
class |
ErrorType
The AWS resource associated with this error: credentials, VPC, subnet, security group, or network
ACL.
|
class |
ExternalCustomerInfo |
class |
GcpKeyInfo |
class |
GcpManagedNetworkConfig
The network settings for the workspace.
|
class |
GcpNetworkInfo
The Google Cloud specific information for this network (for example, the VPC ID, subnet ID, and
secondary IP ranges).
|
class |
GcpVpcEndpointInfo
The Google Cloud specific information for this Private Service Connect endpoint.
|
class |
GetCredentialRequest
Get credential configuration
|
class |
GetEncryptionKeyRequest
Get encryption key configuration
|
class |
GetNetworkRequest
Get a network configuration
|
class |
GetPrivateAccesRequest
Get a private access settings object
|
class |
GetStorageRequest
Get storage configuration
|
class |
GetVpcEndpointRequest
Get a VPC endpoint configuration
|
class |
GetWorkspaceRequest
Get a workspace
|
class |
GkeConfig
The configurations for the GKE cluster of a Databricks workspace.
|
class |
GkeConfigConnectivityType
Specifies the network connectivity types for the GKE nodes and the GKE master network.
|
class |
KeyUseCase
Possible values are: * `MANAGED_SERVICES`: Encrypts notebook and secret data in the control plane
* `STORAGE`: Encrypts the workspace's root S3 bucket (root DBFS and system data) and, optionally,
cluster EBS volumes.
|
class |
Network |
class |
NetworkHealth |
class |
NetworksAPI
These APIs manage network configurations for customer-managed VPCs (optional).
|
interface |
NetworksService
These APIs manage network configurations for customer-managed VPCs (optional).
|
class |
NetworkVpcEndpoints
If specified, contains the VPC endpoints used to allow cluster communication from this VPC over
[AWS PrivateLink].
|
class |
NetworkWarning |
class |
PricingTier
The pricing tier of the workspace.
|
class |
PrivateAccessAPI
These APIs manage private access settings for this account.
|
class |
PrivateAccessLevel
The private access level controls which VPC endpoints can connect to the UI or API of any
workspace that attaches this private access settings object.
|
interface |
PrivateAccessService
These APIs manage private access settings for this account.
|
class |
PrivateAccessSettings |
class |
ReplaceResponse |
class |
RootBucketInfo
Root S3 bucket information.
|
class |
StorageAPI
These APIs manage storage configurations for this workspace.
|
class |
StorageConfiguration |
interface |
StorageService
These APIs manage storage configurations for this workspace.
|
class |
StsRole |
class |
UpdateResponse |
class |
UpdateWorkspaceRequest |
class |
UpsertPrivateAccessSettingsRequest |
class |
VpcEndpoint |
class |
VpcEndpointsAPI
These APIs manage VPC endpoint configurations for this account.
|
interface |
VpcEndpointsService
These APIs manage VPC endpoint configurations for this account.
|
class |
VpcStatus
The status of this network configuration object in terms of its use in a workspace: *
`UNATTACHED`: Unattached.
|
class |
WarningType
The AWS resource associated with this warning: a subnet or a security group.
|
class |
Workspace |
class |
WorkspacesAPI
These APIs manage workspaces for this account.
|
interface |
WorkspacesService
These APIs manage workspaces for this account.
|
class |
WorkspaceStatus
The status of the workspace.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccountIpAccessEnable |
class |
AccountIpAccessListsAPI
The Accounts IP Access List API enables account admins to configure IP access lists for access to
the account console.
|
interface |
AccountIpAccessListsService
The Accounts IP Access List API enables account admins to configure IP access lists for access to
the account console.
|
class |
AccountNetworkPolicy |
class |
AccountSettingsAPI
Accounts Settings API allows users to manage settings at the account level.
|
interface |
AccountSettingsService
Accounts Settings API allows users to manage settings at the account level.
|
class |
AibiDashboardEmbeddingAccessPolicy |
class |
AibiDashboardEmbeddingAccessPolicyAccessPolicyType |
class |
AibiDashboardEmbeddingAccessPolicyAPI
Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or
disabled at the workspace level.
|
interface |
AibiDashboardEmbeddingAccessPolicyService
Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or
disabled at the workspace level.
|
class |
AibiDashboardEmbeddingAccessPolicySetting |
class |
AibiDashboardEmbeddingApprovedDomains |
class |
AibiDashboardEmbeddingApprovedDomainsAPI
Controls the list of domains approved to host the embedded AI/BI dashboards.
|
interface |
AibiDashboardEmbeddingApprovedDomainsService
Controls the list of domains approved to host the embedded AI/BI dashboards.
|
class |
AibiDashboardEmbeddingApprovedDomainsSetting |
class |
AutomaticClusterUpdateAPI
Controls whether automatic cluster update is enabled for the current workspace.
|
interface |
AutomaticClusterUpdateService
Controls whether automatic cluster update is enabled for the current workspace.
|
class |
AutomaticClusterUpdateSetting |
class |
BooleanMessage |
class |
ClusterAutoRestartMessage |
class |
ClusterAutoRestartMessageEnablementDetails
Contains an information about the enablement status judging (e.g.
|
class |
ClusterAutoRestartMessageMaintenanceWindow |
class |
ClusterAutoRestartMessageMaintenanceWindowDayOfWeek |
class |
ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule |
class |
ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency |
class |
ClusterAutoRestartMessageMaintenanceWindowWindowStartTime |
class |
ComplianceSecurityProfile
SHIELD feature: CSP
|
class |
ComplianceSecurityProfileAPI
Controls whether to enable the compliance security profile for the current workspace.
|
interface |
ComplianceSecurityProfileService
Controls whether to enable the compliance security profile for the current workspace.
|
class |
ComplianceSecurityProfileSetting |
class |
ComplianceStandard
Compliance stardard for SHIELD customers
|
class |
Config |
class |
CreateIpAccessList
Details required to configure a block list or allow list.
|
class |
CreateIpAccessListResponse
An IP access list was successfully created.
|
class |
CreateNetworkConnectivityConfigRequest
Create a network connectivity configuration
|
class |
CreateNetworkConnectivityConfiguration
Properties of the new network connectivity configuration.
|
class |
CreateNetworkPolicyRequest
Create a network policy
|
class |
CreateNotificationDestinationRequest |
class |
CreateOboTokenRequest
Configuration details for creating on-behalf tokens.
|
class |
CreateOboTokenResponse
An on-behalf token was successfully created for the service principal.
|
class |
CreatePrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
CreatePrivateEndpointRuleRequest
Create a private endpoint rule
|
class |
CreateTokenRequest |
class |
CreateTokenResponse |
class |
CredentialsManagerAPI
Credentials manager interacts with with Identity Providers to to perform token exchanges using
stored credentials and refresh tokens.
|
interface |
CredentialsManagerService
Credentials manager interacts with with Identity Providers to to perform token exchanges using
stored credentials and refresh tokens.
|
class |
CspEnablementAccount
Account level policy for CSP
|
class |
CspEnablementAccountAPI
The compliance security profile settings at the account level control whether to enable it for
new workspaces.
|
interface |
CspEnablementAccountService
The compliance security profile settings at the account level control whether to enable it for
new workspaces.
|
class |
CspEnablementAccountSetting |
class |
DashboardEmailSubscriptions |
class |
DashboardEmailSubscriptionsAPI
Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can
send subscription emails containing PDFs and/or images of the dashboard.
|
interface |
DashboardEmailSubscriptionsService
Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can
send subscription emails containing PDFs and/or images of the dashboard.
|
class |
DefaultNamespaceAPI
The default namespace setting API allows users to configure the default namespace for a
Databricks workspace.
|
interface |
DefaultNamespaceService
The default namespace setting API allows users to configure the default namespace for a
Databricks workspace.
|
class |
DefaultNamespaceSetting
This represents the setting configuration for the default namespace in the Databricks workspace.
|
class |
DeleteAccountIpAccessEnableRequest
Delete the account IP access toggle setting
|
class |
DeleteAccountIpAccessEnableResponse
The etag is returned.
|
class |
DeleteAccountIpAccessListRequest
Delete access list
|
class |
DeleteAibiDashboardEmbeddingAccessPolicySettingRequest
Delete the AI/BI dashboard embedding access policy
|
class |
DeleteAibiDashboardEmbeddingAccessPolicySettingResponse
The etag is returned.
|
class |
DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest
Delete AI/BI dashboard embedding approved domains
|
class |
DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse
The etag is returned.
|
class |
DeleteDashboardEmailSubscriptionsRequest
Delete the Dashboard Email Subscriptions setting
|
class |
DeleteDashboardEmailSubscriptionsResponse
The etag is returned.
|
class |
DeleteDefaultNamespaceSettingRequest
Delete the default namespace setting
|
class |
DeleteDefaultNamespaceSettingResponse
The etag is returned.
|
class |
DeleteDisableLegacyAccessRequest
Delete Legacy Access Disablement Status
|
class |
DeleteDisableLegacyAccessResponse
The etag is returned.
|
class |
DeleteDisableLegacyDbfsRequest
Delete the disable legacy DBFS setting
|
class |
DeleteDisableLegacyDbfsResponse
The etag is returned.
|
class |
DeleteDisableLegacyFeaturesRequest
Delete the disable legacy features setting
|
class |
DeleteDisableLegacyFeaturesResponse
The etag is returned.
|
class |
DeleteIpAccessListRequest
Delete access list
|
class |
DeleteLlmProxyPartnerPoweredWorkspaceRequest
Delete the enable partner powered AI features workspace setting
|
class |
DeleteLlmProxyPartnerPoweredWorkspaceResponse
The etag is returned.
|
class |
DeleteNetworkConnectivityConfigurationRequest
Delete a network connectivity configuration
|
class |
DeleteNetworkConnectivityConfigurationResponse |
class |
DeleteNetworkPolicyRequest
Delete a network policy
|
class |
DeleteNetworkPolicyRpcResponse |
class |
DeleteNotificationDestinationRequest
Delete a notification destination
|
class |
DeletePersonalComputeSettingRequest
Delete Personal Compute setting
|
class |
DeletePersonalComputeSettingResponse
The etag is returned.
|
class |
DeletePrivateEndpointRuleRequest
Delete a private endpoint rule
|
class |
DeleteResponse |
class |
DeleteRestrictWorkspaceAdminsSettingRequest
Delete the restrict workspace admins setting
|
class |
DeleteRestrictWorkspaceAdminsSettingResponse
The etag is returned.
|
class |
DeleteSqlResultsDownloadRequest
Delete the SQL Results Download setting
|
class |
DeleteSqlResultsDownloadResponse
The etag is returned.
|
class |
DeleteTokenManagementRequest
Delete a token
|
class |
DestinationType |
class |
DisableLegacyAccess |
class |
DisableLegacyAccessAPI
'Disabling legacy access' has the following impacts:
|
interface |
DisableLegacyAccessService
'Disabling legacy access' has the following impacts:
|
class |
DisableLegacyDbfs |
class |
DisableLegacyDbfsAPI
Disabling legacy DBFS has the following implications:
|
interface |
DisableLegacyDbfsService
Disabling legacy DBFS has the following implications:
|
class |
DisableLegacyFeatures |
class |
DisableLegacyFeaturesAPI
Disable legacy features for new Databricks workspaces.
|
interface |
DisableLegacyFeaturesService
Disable legacy features for new Databricks workspaces.
|
class |
EgressNetworkPolicy
The network policies applying for egress traffic.
|
class |
EgressNetworkPolicyInternetAccessPolicy |
class |
EgressNetworkPolicyInternetAccessPolicyInternetDestination
Users can specify accessible internet destinations when outbound access is restricted.
|
class |
EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol
The filtering protocol used by the DP.
|
class |
EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType |
class |
EgressNetworkPolicyInternetAccessPolicyLogOnlyMode |
class |
EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType |
class |
EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType
The values should match the list of workloads used in networkconfig.proto
|
class |
EgressNetworkPolicyInternetAccessPolicyRestrictionMode
At which level can Databricks and Databricks managed compute access Internet.
|
class |
EgressNetworkPolicyInternetAccessPolicyStorageDestination
Users can specify accessible storage destinations.
|
class |
EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType |
class |
EgressNetworkPolicyNetworkAccessPolicy |
class |
EgressNetworkPolicyNetworkAccessPolicyInternetDestination
Users can specify accessible internet destinations when outbound access is restricted.
|
class |
EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType |
class |
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement |
class |
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter
The values should match the list of workloads used in networkconfig.proto
|
class |
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode |
class |
EgressNetworkPolicyNetworkAccessPolicyRestrictionMode
At which level can Databricks and Databricks managed compute access Internet.
|
class |
EgressNetworkPolicyNetworkAccessPolicyStorageDestination
Users can specify accessible storage destinations.
|
class |
EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType |
class |
EgressResourceType
The target resources that are supported by Network Connectivity Config.
|
class |
EmailConfig |
class |
Empty |
class |
EnableExportNotebook |
class |
EnableExportNotebookAPI
Controls whether users can export notebooks and files from the Workspace UI.
|
interface |
EnableExportNotebookService
Controls whether users can export notebooks and files from the Workspace UI.
|
class |
EnableIpAccessListsAPI
Controls the enforcement of IP access lists for accessing the account console.
|
interface |
EnableIpAccessListsService
Controls the enforcement of IP access lists for accessing the account console.
|
class |
EnableNotebookTableClipboard |
class |
EnableNotebookTableClipboardAPI
Controls whether users can copy tabular data to the clipboard via the UI.
|
interface |
EnableNotebookTableClipboardService
Controls whether users can copy tabular data to the clipboard via the UI.
|
class |
EnableResultsDownloading |
class |
EnableResultsDownloadingAPI
Controls whether users can download notebook results.
|
interface |
EnableResultsDownloadingService
Controls whether users can download notebook results.
|
class |
EnhancedSecurityMonitoring
SHIELD feature: ESM
|
class |
EnhancedSecurityMonitoringAPI
Controls whether enhanced security monitoring is enabled for the current workspace.
|
interface |
EnhancedSecurityMonitoringService
Controls whether enhanced security monitoring is enabled for the current workspace.
|
class |
EnhancedSecurityMonitoringSetting |
class |
EsmEnablementAccount
Account level policy for ESM
|
class |
EsmEnablementAccountAPI
The enhanced security monitoring setting at the account level controls whether to enable the
feature on new workspaces.
|
interface |
EsmEnablementAccountService
The enhanced security monitoring setting at the account level controls whether to enable the
feature on new workspaces.
|
class |
EsmEnablementAccountSetting |
class |
ExchangeToken
The exchange token is the result of the token exchange with the IdP
|
class |
ExchangeTokenRequest
Exchange a token with the IdP
|
class |
ExchangeTokenResponse
Exhanged tokens were successfully returned.
|
class |
FetchIpAccessListResponse
An IP access list was successfully returned.
|
class |
GenericWebhookConfig |
class |
GetAccountIpAccessEnableRequest
Get the account IP access toggle setting
|
class |
GetAccountIpAccessListRequest
Get IP access list
|
class |
GetAibiDashboardEmbeddingAccessPolicySettingRequest
Retrieve the AI/BI dashboard embedding access policy
|
class |
GetAibiDashboardEmbeddingApprovedDomainsSettingRequest
Retrieve the list of domains approved to host embedded AI/BI dashboards
|
class |
GetAutomaticClusterUpdateSettingRequest
Get the automatic cluster update setting
|
class |
GetComplianceSecurityProfileSettingRequest
Get the compliance security profile setting
|
class |
GetCspEnablementAccountSettingRequest
Get the compliance security profile setting for new workspaces
|
class |
GetDashboardEmailSubscriptionsRequest
Get the Dashboard Email Subscriptions setting
|
class |
GetDefaultNamespaceSettingRequest
Get the default namespace setting
|
class |
GetDisableLegacyAccessRequest
Retrieve Legacy Access Disablement Status
|
class |
GetDisableLegacyDbfsRequest
Get the disable legacy DBFS setting
|
class |
GetDisableLegacyFeaturesRequest
Get the disable legacy features setting
|
class |
GetEnhancedSecurityMonitoringSettingRequest
Get the enhanced security monitoring setting
|
class |
GetEsmEnablementAccountSettingRequest
Get the enhanced security monitoring setting for new workspaces
|
class |
GetIpAccessListRequest
Get access list
|
class |
GetIpAccessListResponse |
class |
GetIpAccessListsResponse
IP access lists were successfully returned.
|
class |
GetLlmProxyPartnerPoweredAccountRequest
Get the enable partner powered AI features account setting
|
class |
GetLlmProxyPartnerPoweredEnforceRequest
Get the enforcement status of partner powered AI features account setting
|
class |
GetLlmProxyPartnerPoweredWorkspaceRequest
Get the enable partner powered AI features workspace setting
|
class |
GetNetworkConnectivityConfigurationRequest
Get a network connectivity configuration
|
class |
GetNetworkPolicyRequest
Get a network policy
|
class |
GetNotificationDestinationRequest
Get a notification destination
|
class |
GetPersonalComputeSettingRequest
Get Personal Compute setting
|
class |
GetPrivateEndpointRuleRequest
Gets a private endpoint rule
|
class |
GetRestrictWorkspaceAdminsSettingRequest
Get the restrict workspace admins setting
|
class |
GetSqlResultsDownloadRequest
Get the SQL Results Download setting
|
class |
GetStatusRequest
Check configuration status
|
class |
GetTokenManagementRequest
Get token info
|
class |
GetTokenPermissionLevelsResponse |
class |
GetTokenResponse
Token with specified Token ID was successfully returned.
|
class |
GetWorkspaceNetworkOptionRequest
Get workspace network option
|
class |
IpAccessListInfo
Definition of an IP Access list
|
class |
IpAccessListsAPI
IP Access List enables admins to configure IP access lists.
|
interface |
IpAccessListsService
IP Access List enables admins to configure IP access lists.
|
class |
ListIpAccessListResponse
IP access lists were successfully returned.
|
class |
ListNccAzurePrivateEndpointRulesResponse
The private endpoint rule list was successfully retrieved.
|
class |
ListNetworkConnectivityConfigurationsRequest
List network connectivity configurations
|
class |
ListNetworkConnectivityConfigurationsResponse
The network connectivity configuration list was successfully retrieved.
|
class |
ListNetworkPoliciesRequest
List network policies
|
class |
ListNetworkPoliciesResponse |
class |
ListNotificationDestinationsRequest
List notification destinations
|
class |
ListNotificationDestinationsResponse |
class |
ListNotificationDestinationsResult |
class |
ListPrivateEndpointRulesRequest
List private endpoint rules
|
class |
ListPublicTokensResponse |
class |
ListTokenManagementRequest
List all tokens
|
class |
ListTokensResponse
Tokens were successfully returned.
|
class |
ListType
Type of IP access list.
|
class |
LlmProxyPartnerPoweredAccount |
class |
LlmProxyPartnerPoweredAccountAPI
Determines if partner powered models are enabled or not for a specific account
|
interface |
LlmProxyPartnerPoweredAccountService
Determines if partner powered models are enabled or not for a specific account
|
class |
LlmProxyPartnerPoweredEnforce |
class |
LlmProxyPartnerPoweredEnforceAPI
Determines if the account-level partner-powered setting value is enforced upon the
workspace-level partner-powered setting
|
interface |
LlmProxyPartnerPoweredEnforceService
Determines if the account-level partner-powered setting value is enforced upon the
workspace-level partner-powered setting
|
class |
LlmProxyPartnerPoweredWorkspace |
class |
LlmProxyPartnerPoweredWorkspaceAPI
Determines if partner powered models are enabled or not for a specific workspace
|
interface |
LlmProxyPartnerPoweredWorkspaceService
Determines if partner powered models are enabled or not for a specific workspace
|
class |
MicrosoftTeamsConfig |
class |
NccAwsStableIpRule
The stable AWS IP CIDR blocks.
|
class |
NccAzurePrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
NccAzurePrivateEndpointRuleConnectionState |
class |
NccAzureServiceEndpointRule
The stable Azure service endpoints.
|
class |
NccEgressConfig |
class |
NccEgressDefaultRules
Default rules don't have specific targets.
|
class |
NccEgressTargetRules
Target rule controls the egress rules that are dedicated to specific resources.
|
class |
NetworkConnectivityAPI
These APIs provide configurations for the network connectivity of your workspaces for serverless
compute resources.
|
class |
NetworkConnectivityConfiguration
Properties of the new network connectivity configuration.
|
interface |
NetworkConnectivityService
These APIs provide configurations for the network connectivity of your workspaces for serverless
compute resources.
|
class |
NetworkPoliciesAPI
These APIs manage network policies for this account.
|
interface |
NetworkPoliciesService
These APIs manage network policies for this account.
|
class |
NetworkPolicyEgress
The network policies applying for egress traffic.
|
class |
NotificationDestination |
class |
NotificationDestinationsAPI
The notification destinations API lets you programmatically manage a workspace's notification
destinations.
|
interface |
NotificationDestinationsService
The notification destinations API lets you programmatically manage a workspace's notification
destinations.
|
class |
PagerdutyConfig |
class |
PartitionId
Partition by workspace or account
|
class |
PersonalComputeAPI
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
class |
PersonalComputeMessage |
class |
PersonalComputeMessageEnum
ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing
all users to create single-machine compute resources.
|
interface |
PersonalComputeService
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
class |
PersonalComputeSetting |
class |
PublicTokenInfo |
class |
ReplaceIpAccessList
Details required to replace an IP access list.
|
class |
ReplaceResponse |
class |
RestrictWorkspaceAdminsAPI
The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.
|
class |
RestrictWorkspaceAdminsMessage |
class |
RestrictWorkspaceAdminsMessageStatus |
interface |
RestrictWorkspaceAdminsService
The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.
|
class |
RestrictWorkspaceAdminsSetting |
class |
RevokeTokenRequest |
class |
RevokeTokenResponse |
class |
SetStatusResponse |
class |
SettingsAPI
Workspace Settings API allows users to manage settings at the workspace level.
|
interface |
SettingsService
Workspace Settings API allows users to manage settings at the workspace level.
|
class |
SlackConfig |
class |
SqlResultsDownload |
class |
SqlResultsDownloadAPI
Controls whether users within the workspace are allowed to download results from the SQL Editor
and AI/BI Dashboards UIs.
|
interface |
SqlResultsDownloadService
Controls whether users within the workspace are allowed to download results from the SQL Editor
and AI/BI Dashboards UIs.
|
class |
StringMessage |
class |
TokenAccessControlRequest |
class |
TokenAccessControlResponse |
class |
TokenInfo |
class |
TokenManagementAPI
Enables administrators to get all tokens and delete tokens for other users.
|
interface |
TokenManagementService
Enables administrators to get all tokens and delete tokens for other users.
|
class |
TokenPermission |
class |
TokenPermissionLevel
Permission level
|
class |
TokenPermissions |
class |
TokenPermissionsDescription |
class |
TokenPermissionsRequest |
class |
TokensAPI
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and
access Databricks REST APIs.
|
interface |
TokensService
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and
access Databricks REST APIs.
|
class |
TokenType
The type of token request.
|
class |
UpdateAccountIpAccessEnableRequest
Details required to update a setting.
|
class |
UpdateAibiDashboardEmbeddingAccessPolicySettingRequest
Details required to update a setting.
|
class |
UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest
Details required to update a setting.
|
class |
UpdateAutomaticClusterUpdateSettingRequest
Details required to update a setting.
|
class |
UpdateComplianceSecurityProfileSettingRequest
Details required to update a setting.
|
class |
UpdateCspEnablementAccountSettingRequest
Details required to update a setting.
|
class |
UpdateDashboardEmailSubscriptionsRequest
Details required to update a setting.
|
class |
UpdateDefaultNamespaceSettingRequest
Details required to update a setting.
|
class |
UpdateDisableLegacyAccessRequest
Details required to update a setting.
|
class |
UpdateDisableLegacyDbfsRequest
Details required to update a setting.
|
class |
UpdateDisableLegacyFeaturesRequest
Details required to update a setting.
|
class |
UpdateEnableExportNotebookRequest
Details required to update a setting.
|
class |
UpdateEnableNotebookTableClipboardRequest
Details required to update a setting.
|
class |
UpdateEnableResultsDownloadingRequest
Details required to update a setting.
|
class |
UpdateEnhancedSecurityMonitoringSettingRequest
Details required to update a setting.
|
class |
UpdateEsmEnablementAccountSettingRequest
Details required to update a setting.
|
class |
UpdateIpAccessList
Details required to update an IP access list.
|
class |
UpdateLlmProxyPartnerPoweredAccountRequest
Details required to update a setting.
|
class |
UpdateLlmProxyPartnerPoweredEnforceRequest
Details required to update a setting.
|
class |
UpdateLlmProxyPartnerPoweredWorkspaceRequest
Details required to update a setting.
|
class |
UpdateNccAzurePrivateEndpointRulePublicRequest
Update a private endpoint rule
|
class |
UpdateNetworkPolicyRequest
Update a network policy
|
class |
UpdateNotificationDestinationRequest |
class |
UpdatePersonalComputeSettingRequest
Details required to update a setting.
|
class |
UpdatePrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
UpdateResponse |
class |
UpdateRestrictWorkspaceAdminsSettingRequest
Details required to update a setting.
|
class |
UpdateSqlResultsDownloadRequest
Details required to update a setting.
|
class |
UpdateWorkspaceNetworkOptionRequest
Update workspace network option
|
class |
WorkspaceConfAPI
This API allows updating known workspace settings for advanced users.
|
interface |
WorkspaceConfService
This API allows updating known workspace settings for advanced users.
|
class |
WorkspaceNetworkConfigurationAPI
These APIs allow configuration of network settings for Databricks workspaces by selecting which
network policy to associate with the workspace.
|
interface |
WorkspaceNetworkConfigurationService
These APIs allow configuration of network settings for Databricks workspaces by selecting which
network policy to associate with the workspace.
|
class |
WorkspaceNetworkOption |
| Modifier and Type | Class and Description |
|---|---|
class |
AuthenticationType
The delta sharing authentication type.
|
class |
ColumnTypeName
UC supported column types Copied from
https://src.dev.databricks.com/databricks/universe@23a85902bb58695ab9293adc9f327b0714b55e72/-/blob/managed-catalog/api/messages/table.proto?L68
|
class |
CreateFederationPolicyRequest
Create recipient federation policy
|
class |
CreateProvider |
class |
CreateRecipient |
class |
CreateShare |
class |
DeleteFederationPolicyRequest
Delete recipient federation policy
|
class |
DeleteProviderRequest
Delete a provider
|
class |
DeleteRecipientRequest
Delete a share recipient
|
class |
DeleteResponse |
class |
DeleteShareRequest
Delete a share
|
class |
DeltaSharingDependency
Represents a UC dependency.
|
class |
DeltaSharingDependencyList
Represents a list of dependencies.
|
class |
DeltaSharingFunction |
class |
DeltaSharingFunctionDependency
A Function in UC as a dependency.
|
class |
DeltaSharingTableDependency
A Table in UC as a dependency.
|
class |
FederationPolicy |
class |
FunctionParameterInfo
Represents a parameter of a function.
|
class |
FunctionParameterInfos |
class |
FunctionParameterMode |
class |
FunctionParameterType |
class |
GetActivationUrlInfoRequest
Get a share activation URL
|
class |
GetActivationUrlInfoResponse |
class |
GetFederationPolicyRequest
Get recipient federation policy
|
class |
GetProviderRequest
Get a provider
|
class |
GetRecipientRequest
Get a share recipient
|
class |
GetRecipientSharePermissionsResponse |
class |
GetSharePermissionsResponse |
class |
GetShareRequest
Get a share
|
class |
IpAccessList |
class |
ListFederationPoliciesRequest
List recipient federation policies
|
class |
ListFederationPoliciesResponse |
class |
ListProviderShareAssetsRequest
List assets by provider share
|
class |
ListProviderShareAssetsResponse
Response to ListProviderShareAssets, which contains the list of assets of a share.
|
class |
ListProviderSharesResponse |
class |
ListProvidersRequest
List providers
|
class |
ListProvidersResponse |
class |
ListRecipientsRequest
List share recipients
|
class |
ListRecipientsResponse |
class |
ListSharesRequest
List shares by Provider
|
class |
ListSharesResponse |
class |
NotebookFile |
class |
OidcFederationPolicy
Specifies the policy to use for validating OIDC claims in your federated tokens from Delta
Sharing Clients.
|
class |
Partition |
class |
PartitionValue |
class |
PartitionValueOp |
class |
PermissionsChange |
class |
Privilege |
class |
PrivilegeAssignment |
class |
ProviderInfo |
class |
ProvidersAPI
A data provider is an object representing the organization in the real world who shares the data.
|
class |
ProviderShare |
interface |
ProvidersService
A data provider is an object representing the organization in the real world who shares the data.
|
class |
RecipientActivationAPI
The Recipient Activation API is only applicable in the open sharing model where the recipient
object has the authentication type of `TOKEN`.
|
interface |
RecipientActivationService
The Recipient Activation API is only applicable in the open sharing model where the recipient
object has the authentication type of `TOKEN`.
|
class |
RecipientFederationPoliciesAPI
The Recipient Federation Policies APIs are only applicable in the open sharing model where the
recipient object has the authentication type of `OIDC_RECIPIENT`, enabling data sharing from
Databricks to non-Databricks recipients.
|
interface |
RecipientFederationPoliciesService
The Recipient Federation Policies APIs are only applicable in the open sharing model where the
recipient object has the authentication type of `OIDC_RECIPIENT`, enabling data sharing from
Databricks to non-Databricks recipients.
|
class |
RecipientInfo |
class |
RecipientProfile |
class |
RecipientsAPI
A recipient is an object you create using :method:recipients/create to represent an organization
which you want to allow access shares.
|
interface |
RecipientsService
A recipient is an object you create using :method:recipients/create to represent an organization
which you want to allow access shares.
|
class |
RecipientTokenInfo |
class |
RegisteredModelAlias |
class |
RetrieveTokenRequest
Get an access token
|
class |
RetrieveTokenResponse |
class |
RotateRecipientToken |
class |
SecurablePropertiesKvPairs
An object with __properties__ containing map of key-value properties attached to the securable.
|
class |
SharedDataObject |
class |
SharedDataObjectDataObjectType |
class |
SharedDataObjectHistoryDataSharingStatus |
class |
SharedDataObjectStatus |
class |
SharedDataObjectUpdate |
class |
SharedDataObjectUpdateAction |
class |
SharedSecurableKind
The SecurableKind of a delta-shared object.
|
class |
ShareInfo |
class |
SharePermissionsRequest
Get recipient share permissions
|
class |
SharesAPI
A share is a container instantiated with :method:shares/create.
|
interface |
SharesService
A share is a container instantiated with :method:shares/create.
|
class |
ShareToPrivilegeAssignment |
class |
Table |
class |
TableInternalAttributes
Internal information for D2D sharing that should not be disclosed to external users.
|
class |
TableInternalAttributesSharedTableType |
class |
UpdateFederationPolicyRequest
Update recipient federation policy
|
class |
UpdateProvider |
class |
UpdateRecipient |
class |
UpdateShare |
class |
UpdateSharePermissions |
class |
UpdateSharePermissionsResponse |
class |
Volume |
class |
VolumeInternalAttributes
Internal information for D2D sharing that should not be disclosed to external users.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccessControl |
class |
Aggregation |
class |
Alert |
class |
AlertCondition |
class |
AlertConditionOperand |
class |
AlertConditionThreshold |
class |
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
|
class |
AlertOperandColumn |
class |
AlertOperandValue |
class |
AlertOperator |
class |
AlertOptions
Alert configuration options.
|
class |
AlertOptionsEmptyResultState
State that alert evaluates to when query result is empty.
|
class |
AlertQuery |
class |
AlertsAPI
The alerts API can be used to perform CRUD operations on alerts.
|
class |
AlertsLegacyAPI
The alerts API can be used to perform CRUD operations on alerts.
|
interface |
AlertsLegacyService
The alerts API can be used to perform CRUD operations on alerts.
|
interface |
AlertsService
The alerts API can be used to perform CRUD operations on alerts.
|
class |
AlertState |
class |
AlertsV2API
New version of SQL Alerts
|
interface |
AlertsV2Service
New version of SQL Alerts
|
class |
AlertV2 |
class |
AlertV2Evaluation |
class |
AlertV2Notification |
class |
AlertV2Operand |
class |
AlertV2OperandColumn |
class |
AlertV2OperandValue |
class |
AlertV2Subscription |
class |
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.
|
class |
CancelExecutionRequest
Cancel statement execution
|
class |
CancelExecutionResponse |
class |
Channel
Configures the channel name and DBSQL version of the warehouse.
|
class |
ChannelInfo
Details about a Channel.
|
class |
ChannelName |
class |
ClientConfig |
class |
ColumnInfo |
class |
ColumnInfoTypeName
The name of the base data type.
|
class |
ComparisonOperator |
class |
CreateAlert |
class |
CreateAlertRequest |
class |
CreateAlertRequestAlert |
class |
CreateAlertV2Request
Create an alert
|
class |
CreateQueryRequest |
class |
CreateQueryRequestQuery |
class |
CreateQueryVisualizationsLegacyRequest
Add visualization to a query
|
class |
CreateVisualizationRequest |
class |
CreateVisualizationRequestVisualization |
class |
CreateWarehouseRequest |
class |
CreateWarehouseRequestWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
CreateWarehouseResponse |
class |
CreateWidget |
class |
CronSchedule |
class |
Dashboard
A JSON representing a dashboard containing widgets of visualizations and text boxes.
|
class |
DashboardEditContent |
class |
DashboardOptions |
class |
DashboardPostContent |
class |
DashboardsAPI
In general, there is little need to modify dashboards using the API.
|
interface |
DashboardsService
In general, there is little need to modify dashboards using the API.
|
class |
DashboardWidgetsAPI
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
interface |
DashboardWidgetsService
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
class |
DataSource
A JSON object representing a DBSQL data source / SQL warehouse.
|
class |
DataSourcesAPI
This API is provided to assist you in making new query objects.
|
interface |
DataSourcesService
This API is provided to assist you in making new query objects.
|
class |
DatePrecision |
class |
DateRange |
class |
DateRangeValue |
class |
DateRangeValueDynamicDateRange |
class |
DateValue |
class |
DateValueDynamicDate |
class |
DbsqlPermissionsAPI
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
interface |
DbsqlPermissionsService
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
class |
DeleteAlertsLegacyRequest
Delete an alert
|
class |
DeleteDashboardRequest
Remove a dashboard
|
class |
DeleteDashboardWidgetRequest
Remove widget
|
class |
DeleteQueriesLegacyRequest
Delete a query
|
class |
DeleteQueryVisualizationsLegacyRequest
Remove visualization
|
class |
DeleteResponse |
class |
DeleteVisualizationRequest
Remove a visualization
|
class |
DeleteWarehouseRequest
Delete a warehouse
|
class |
DeleteWarehouseResponse |
class |
Disposition |
class |
EditAlert |
class |
EditWarehouseRequest |
class |
EditWarehouseRequestWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
EditWarehouseResponse |
class |
Empty
Represents an empty message, similar to google.protobuf.Empty, which is not available in the firm
right now.
|
class |
EndpointConfPair |
class |
EndpointHealth |
class |
EndpointInfo |
class |
EndpointInfoWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
EndpointTagPair |
class |
EndpointTags |
class |
EnumValue |
class |
ExecuteStatementRequest |
class |
ExecuteStatementRequestOnWaitTimeout
When `wait_timeout > 0s`, the call will block up to the specified time.
|
class |
ExternalLink |
class |
ExternalQuerySource |
class |
ExternalQuerySourceJobInfo |
class |
Format |
class |
GetAlertRequest
Get an alert
|
class |
GetAlertsLegacyRequest
Get an alert
|
class |
GetAlertV2Request
Get an alert
|
class |
GetDashboardRequest
Retrieve a definition
|
class |
GetDbsqlPermissionRequest
Get object ACL
|
class |
GetQueriesLegacyRequest
Get a query definition.
|
class |
GetQueryRequest
Get a query
|
class |
GetResponse |
class |
GetStatementRequest
Get status, manifest, and result first chunk
|
class |
GetStatementResultChunkNRequest
Get result chunk by index
|
class |
GetWarehousePermissionLevelsRequest
Get SQL warehouse permission levels
|
class |
GetWarehousePermissionLevelsResponse |
class |
GetWarehousePermissionsRequest
Get SQL warehouse permissions
|
class |
GetWarehouseRequest
Get warehouse info
|
class |
GetWarehouseResponse |
class |
GetWarehouseResponseWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
GetWorkspaceWarehouseConfigResponse |
class |
GetWorkspaceWarehouseConfigResponseSecurityPolicy
Security policy for warehouses
|
class |
LegacyAlert |
class |
LegacyAlertState
State of the alert.
|
class |
LegacyQuery |
class |
LegacyVisualization
The visualization description API changes frequently and is unsupported.
|
class |
LifecycleState |
class |
ListAlertsRequest
List alerts
|
class |
ListAlertsResponse |
class |
ListAlertsResponseAlert |
class |
ListAlertsV2Request
List alerts
|
class |
ListAlertsV2Response |
class |
ListDashboardsRequest
Get dashboard objects
|
class |
ListOrder |
class |
ListQueriesLegacyRequest
Get a list of queries
|
class |
ListQueriesRequest
List queries
|
class |
ListQueriesResponse |
class |
ListQueryHistoryRequest
List Queries
|
class |
ListQueryObjectsResponse |
class |
ListQueryObjectsResponseQuery |
class |
ListResponse |
class |
ListVisualizationsForQueryRequest
List visualizations on a query
|
class |
ListVisualizationsForQueryResponse |
class |
ListWarehousesRequest
List warehouses
|
class |
ListWarehousesResponse |
class |
MultiValuesOptions |
class |
NumericValue |
class |
ObjectType
A singular noun object type.
|
class |
ObjectTypePlural
Always a plural of the object type.
|
class |
OdbcParams |
class |
OwnableObjectType
The singular form of the type of object which can be owned.
|
class |
Parameter |
class |
ParameterType
Parameters can have several different types.
|
class |
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
|
class |
PlansState
Possible Reasons for which we have not saved plans in the database
|
class |
QueriesAPI
The queries API can be used to perform CRUD operations on queries.
|
class |
QueriesLegacyAPI
These endpoints are used for CRUD operations on query definitions.
|
interface |
QueriesLegacyService
These endpoints are used for CRUD operations on query definitions.
|
interface |
QueriesService
The queries API can be used to perform CRUD operations on queries.
|
class |
Query |
class |
QueryBackedValue |
class |
QueryEditContent |
class |
QueryFilter |
class |
QueryHistoryAPI
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
interface |
QueryHistoryService
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
class |
QueryInfo |
class |
QueryList |
class |
QueryMetrics
A query metric that encapsulates a set of measurements for a single query.
|
class |
QueryOptions |
class |
QueryParameter |
class |
QueryPostContent |
class |
QueryStatementType |
class |
QueryStatus
Statuses which are also used by OperationStatus in runtime
|
class |
QueryVisualizationsAPI
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
class |
QueryVisualizationsLegacyAPI
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
interface |
QueryVisualizationsLegacyService
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
interface |
QueryVisualizationsService
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
class |
RedashConfigAPI
Redash V2 service for workspace configurations (internal)
|
interface |
RedashConfigService
Redash V2 service for workspace configurations (internal)
|
class |
RepeatedEndpointConfPairs |
class |
RestoreDashboardRequest
Restore a dashboard
|
class |
RestoreQueriesLegacyRequest
Restore a query
|
class |
RestoreResponse |
class |
ResultData |
class |
ResultManifest
The result manifest provides schema and metadata for the result set.
|
class |
ResultSchema
The schema is an ordered list of column descriptions.
|
class |
RunAsMode |
class |
RunAsRole
Sets the **Run as** role for the object.
|
class |
SchedulePauseStatus |
class |
ServiceError |
class |
ServiceErrorCode |
class |
SetRequest
Set object ACL
|
class |
SetResponse |
class |
SetWorkspaceWarehouseConfigRequest |
class |
SetWorkspaceWarehouseConfigRequestSecurityPolicy
Security policy for warehouses
|
class |
SetWorkspaceWarehouseConfigResponse |
class |
SpotInstancePolicy
Configurations whether the warehouse should use spot instances.
|
class |
StartRequest
Start a warehouse
|
class |
StartWarehouseResponse |
class |
State
State of the warehouse
|
class |
StatementExecutionAPI
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
interface |
StatementExecutionService
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
class |
StatementParameterListItem |
class |
StatementResponse |
class |
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
|
class |
StatementStatus
The status response includes execution state and if relevant, error information.
|
class |
Status
Health status of the warehouse.
|
class |
StopRequest
Stop a warehouse
|
class |
StopWarehouseResponse |
class |
Success |
class |
SuccessMessage |
class |
TerminationReason |
class |
TerminationReasonCode
status code indicating why the cluster was terminated
|
class |
TerminationReasonType
type of the termination
|
class |
TextValue |
class |
TimeRange |
class |
TransferOwnershipObjectId |
class |
TransferOwnershipRequest
Transfer object ownership
|
class |
TrashAlertRequest
Delete an alert
|
class |
TrashAlertV2Request
Delete an alert
|
class |
TrashQueryRequest
Delete a query
|
class |
UpdateAlertRequest |
class |
UpdateAlertRequestAlert |
class |
UpdateAlertV2Request
Update an alert
|
class |
UpdateQueryRequest |
class |
UpdateQueryRequestQuery |
class |
UpdateResponse |
class |
UpdateVisualizationRequest |
class |
UpdateVisualizationRequestVisualization |
class |
User |
class |
Visualization |
class |
WarehouseAccessControlRequest |
class |
WarehouseAccessControlResponse |
class |
WarehousePermission |
class |
WarehousePermissionLevel
Permission level
|
class |
WarehousePermissions |
class |
WarehousePermissionsDescription |
class |
WarehousePermissionsRequest |
class |
WarehousesAPI
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
interface |
WarehousesService
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
class |
WarehouseTypePair |
class |
WarehouseTypePairWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
Widget |
class |
WidgetOptions |
class |
WidgetPosition
Coordinates of this widget on a dashboard.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ColumnInfo |
class |
CreateEndpoint |
class |
CreateVectorIndexRequest |
class |
CustomTag |
class |
DeleteDataResult |
class |
DeleteDataStatus |
class |
DeleteDataVectorIndexRequest
Delete data from index
|
class |
DeleteDataVectorIndexResponse |
class |
DeleteEndpointRequest
Delete an endpoint
|
class |
DeleteEndpointResponse |
class |
DeleteIndexRequest
Delete an index
|
class |
DeleteIndexResponse |
class |
DeltaSyncVectorIndexSpecRequest |
class |
DeltaSyncVectorIndexSpecResponse |
class |
DirectAccessVectorIndexSpec |
class |
EmbeddingSourceColumn |
class |
EmbeddingVectorColumn |
class |
EndpointInfo |
class |
EndpointStatus
Status information of an endpoint
|
class |
EndpointStatusState
Current state of the endpoint
|
class |
EndpointType
Type of endpoint.
|
class |
GetEndpointRequest
Get an endpoint
|
class |
GetIndexRequest
Get an index
|
class |
ListEndpointResponse |
class |
ListEndpointsRequest
List all endpoints
|
class |
ListIndexesRequest
List indexes
|
class |
ListValue |
class |
ListVectorIndexesResponse |
class |
MapStringValueEntry
Key-value pair.
|
class |
MiniVectorIndex |
class |
PatchEndpointBudgetPolicyRequest |
class |
PatchEndpointBudgetPolicyResponse |
class |
PipelineType
Pipeline execution mode.
|
class |
QueryVectorIndexNextPageRequest
Request payload for getting next page of results.
|
class |
QueryVectorIndexRequest |
class |
QueryVectorIndexResponse |
class |
ResultData
Data returned in the query result.
|
class |
ResultManifest
Metadata about the result set.
|
class |
ScanVectorIndexRequest |
class |
ScanVectorIndexResponse
Response to a scan vector index request.
|
class |
Struct |
class |
SyncIndexRequest
Synchronize an index
|
class |
SyncIndexResponse |
class |
UpdateEndpointCustomTagsRequest |
class |
UpdateEndpointCustomTagsResponse |
class |
UpsertDataResult |
class |
UpsertDataStatus |
class |
UpsertDataVectorIndexRequest |
class |
UpsertDataVectorIndexResponse |
class |
Value |
class |
VectorIndex |
class |
VectorIndexStatus |
class |
VectorIndexType
There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs
with a source Delta Table, automatically and incrementally updating the index as the underlying
data in the Delta Table changes.
|
class |
VectorSearchEndpointsAPI
Endpoint**: Represents the compute resources to host vector search indexes.
|
interface |
VectorSearchEndpointsService
**Endpoint**: Represents the compute resources to host vector search indexes.
|
class |
VectorSearchIndexesAPI
**Index**: An efficient representation of your embedding vectors that supports real-time and
efficient approximate nearest neighbor (ANN) search queries.
|
interface |
VectorSearchIndexesService
**Index**: An efficient representation of your embedding vectors that supports real-time and
efficient approximate nearest neighbor (ANN) search queries.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AclItem |
class |
AclPermission |
class |
AzureKeyVaultSecretScopeMetadata |
class |
CreateCredentialsRequest |
class |
CreateCredentialsResponse |
class |
CreateRepoRequest |
class |
CreateRepoResponse |
class |
CreateScope |
class |
CreateScopeResponse |
class |
CredentialInfo |
class |
Delete |
class |
DeleteAcl |
class |
DeleteAclResponse |
class |
DeleteCredentialsRequest
Delete a credential
|
class |
DeleteCredentialsResponse |
class |
DeleteRepoRequest
Delete a repo
|
class |
DeleteRepoResponse |
class |
DeleteResponse |
class |
DeleteScope |
class |
DeleteScopeResponse |
class |
DeleteSecret |
class |
DeleteSecretResponse |
class |
ExportFormat
The format for workspace import and export.
|
class |
ExportRequest
Export a workspace object
|
class |
ExportResponse
The request field `direct_download` determines whether a JSON response or binary contents are
returned by this endpoint.
|
class |
GetAclRequest
Get secret ACL details
|
class |
GetCredentialsRequest
Get a credential entry
|
class |
GetCredentialsResponse |
class |
GetRepoPermissionLevelsRequest
Get repo permission levels
|
class |
GetRepoPermissionLevelsResponse |
class |
GetRepoPermissionsRequest
Get repo permissions
|
class |
GetRepoRequest
Get a repo
|
class |
GetRepoResponse |
class |
GetSecretRequest
Get a secret
|
class |
GetSecretResponse |
class |
GetStatusRequest
Get status
|
class |
GetWorkspaceObjectPermissionLevelsRequest
Get workspace object permission levels
|
class |
GetWorkspaceObjectPermissionLevelsResponse |
class |
GetWorkspaceObjectPermissionsRequest
Get workspace object permissions
|
class |
GitCredentialsAPI
Registers personal access token for Databricks to do operations on behalf of the user.
|
interface |
GitCredentialsService
Registers personal access token for Databricks to do operations on behalf of the user.
|
class |
Import |
class |
ImportFormat
The format for workspace import and export.
|
class |
ImportResponse |
class |
Language
The language of notebook.
|
class |
ListAclsRequest
Lists ACLs
|
class |
ListAclsResponse |
class |
ListCredentialsResponse |
class |
ListReposRequest
Get repos
|
class |
ListReposResponse |
class |
ListResponse |
class |
ListScopesResponse |
class |
ListSecretsRequest
List secret keys
|
class |
ListSecretsResponse |
class |
ListWorkspaceRequest
List contents
|
class |
Mkdirs |
class |
MkdirsResponse |
class |
ObjectInfo
The information of the object in workspace.
|
class |
ObjectType
The type of the object in workspace.
|
class |
PutAcl |
class |
PutAclResponse |
class |
PutSecret |
class |
PutSecretResponse |
class |
RepoAccessControlRequest |
class |
RepoAccessControlResponse |
class |
RepoInfo
Git folder (repo) information.
|
class |
RepoPermission |
class |
RepoPermissionLevel
Permission level
|
class |
RepoPermissions |
class |
RepoPermissionsDescription |
class |
RepoPermissionsRequest |
class |
ReposAPI
The Repos API allows users to manage their git repos.
|
interface |
ReposService
The Repos API allows users to manage their git repos.
|
class |
ScopeBackendType |
class |
SecretMetadata |
class |
SecretsAPI
The Secrets API allows you to manage secrets, secret scopes, and access permissions.
|
class |
SecretScope |
interface |
SecretsService
The Secrets API allows you to manage secrets, secret scopes, and access permissions.
|
class |
SparseCheckout
Sparse checkout configuration, it contains options like cone patterns.
|
class |
SparseCheckoutUpdate
Sparse checkout configuration, it contains options like cone patterns.
|
class |
UpdateCredentialsRequest |
class |
UpdateCredentialsResponse |
class |
UpdateRepoRequest |
class |
UpdateRepoResponse |
class |
WorkspaceAPI
The Workspace API allows you to list, import, export, and delete notebooks and folders.
|
class |
WorkspaceObjectAccessControlRequest |
class |
WorkspaceObjectAccessControlResponse |
class |
WorkspaceObjectPermission |
class |
WorkspaceObjectPermissionLevel
Permission level
|
class |
WorkspaceObjectPermissions |
class |
WorkspaceObjectPermissionsDescription |
class |
WorkspaceObjectPermissionsRequest |
interface |
WorkspaceService
The Workspace API allows you to list, import, export, and delete notebooks and folders.
|
Copyright © 2025. All rights reserved.