| 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 |
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 |
Budget
Budget configuration to be created.
|
class |
BudgetAlert |
class |
BudgetList
List of budgets.
|
class |
BudgetsAPI
These APIs manage budget configuration including notifications for exceeding a budget for a
period.
|
interface |
BudgetsService
These APIs manage budget configuration including notifications for exceeding a budget for a
period.
|
class |
BudgetWithStatus
Budget configuration with daily status.
|
class |
BudgetWithStatusStatusDailyItem |
class |
CreateLogDeliveryConfigurationParams |
class |
DeleteBudgetRequest
Delete budget
|
class |
DeliveryStatus
This describes an enum
|
class |
DownloadRequest
Return billable usage logs
|
class |
GetBudgetRequest
Get budget and its status
|
class |
GetLogDeliveryRequest
Get log delivery configuration
|
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 |
UpdateLogDeliveryConfigurationStatusRequest |
class |
WrappedBudget |
class |
WrappedBudgetWithStatus |
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 |
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 |
AwsIamRole |
class |
AzureManagedIdentity |
class |
AzureServicePrincipal |
class |
CatalogInfo |
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 |
ColumnInfo |
class |
ColumnMask |
class |
ColumnTypeName
Name of type (INT, STRUCT, MAP, etc.).
|
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
The type of connection.
|
class |
CreateCatalog |
class |
CreateConnection |
class |
CreateExternalLocation |
class |
CreateFunction |
class |
CreateFunctionParameterStyle
Function parameter style.
|
class |
CreateFunctionRoutineBody
Function language.
|
class |
CreateFunctionSecurityType
Function security type.
|
class |
CreateFunctionSqlDataAccess
Function SQL data access.
|
class |
CreateMetastore |
class |
CreateMetastoreAssignment |
class |
CreateMetastoreAssignmentsResponseItem |
class |
CreateSchema |
class |
CreateStorageCredential |
class |
CreateTableConstraint |
class |
CreateVolumeRequestContent |
class |
CredentialType
The type of credential.
|
class |
CurrentWorkspaceBindings
Currently assigned workspaces
|
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 |
DeleteCatalogRequest
Delete a catalog
|
class |
DeleteConnectionRequest
Delete a connection
|
class |
DeleteExternalLocationRequest
Delete an external location
|
class |
DeleteFunctionRequest
Delete a function
|
class |
DeleteMetastoreRequest
Delete a metastore
|
class |
DeleteSchemaRequest
Delete a schema
|
class |
DeleteStorageCredentialRequest
Delete a credential
|
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 |
DisableRequest
Disable a system schema
|
class |
DisableSchemaName |
class |
EffectiveAutoMaintenanceFlag |
class |
EffectiveAutoMaintenanceFlagInheritedFromType
The type of the object from which the flag was inherited.
|
class |
EffectivePermissionsList |
class |
EffectivePrivilege |
class |
EffectivePrivilegeAssignment |
class |
EnableAutoMaintenance
Whether auto maintenance should be enabled for this object and objects under it.
|
class |
EnableRequest
Enable a system schema
|
class |
EnableSchemaName |
class |
EncryptionDetails
Encryption options that apply to clients connecting to cloud storage.
|
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 |
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
Function security type.
|
class |
FunctionInfoSqlDataAccess
Function SQL data access.
|
class |
FunctionParameterInfo |
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 |
GetAccountMetastoreAssignmentRequest
Gets the metastore assignment for a workspace
|
class |
GetAccountMetastoreRequest
Get a metastore
|
class |
GetAccountStorageCredentialRequest
Gets the named storage credential
|
class |
GetCatalogRequest
Get a catalog
|
class |
GetConnectionRequest
Get a connection
|
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 |
GetSchemaRequest
Get a schema
|
class |
GetStorageCredentialRequest
Get a credential
|
class |
GetTableRequest
Get a table
|
class |
GetWorkspaceBindingRequest
Get catalog workspace bindings
|
class |
GrantsAPI
In Unity Catalog, data is secure by default.
|
interface |
GrantsService
In Unity Catalog, data is secure by default.
|
class |
IsolationMode
Whether the current securable is accessible from all workspaces or a specific set of workspaces.
|
class |
ListAccountMetastoreAssignmentsRequest
Get all workspaces assigned to a metastore
|
class |
ListAccountStorageCredentialsRequest
Get all storage credentials assigned to a metastore
|
class |
ListCatalogsResponse |
class |
ListConnectionsResponse |
class |
ListExternalLocationsResponse |
class |
ListFunctionsRequest
List functions
|
class |
ListFunctionsResponse |
class |
ListMetastoresResponse |
class |
ListSchemasRequest
List schemas
|
class |
ListSchemasResponse |
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 |
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 |
NamedTableConstraint |
class |
PermissionsChange |
class |
PermissionsList |
class |
PrimaryKeyConstraint |
class |
Privilege |
class |
PrivilegeAssignment |
class |
ReadVolumeRequest
Get a Volume
|
class |
SchemaInfo |
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 |
SseEncryptionDetails
Server-Side Encryption properties for clients communicating with AWS s3.
|
class |
SseEncryptionDetailsAlgorithm
The type of key encryption to use (affects headers from s3 client).
|
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 |
SystemSchemaInfo |
class |
SystemSchemaInfoState
The current state of enablement for the system schema.
|
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 |
TableConstraintList |
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 |
TableInfo |
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 |
UnassignRequest
Delete an assignment
|
class |
UpdateAutoMaintenance |
class |
UpdateAutoMaintenanceResponse |
class |
UpdateCatalog |
class |
UpdateConnection |
class |
UpdateExternalLocation |
class |
UpdateFunction |
class |
UpdateMetastore |
class |
UpdateMetastoreAssignment |
class |
UpdateMetastoreDeltaSharingScope
The scope of Delta Sharing enabled for the metastore.
|
class |
UpdatePermissions |
class |
UpdatePredictiveOptimization |
class |
UpdatePredictiveOptimizationResponse |
class |
UpdateSchema |
class |
UpdateStorageCredential |
class |
UpdateTableRequest
Update a table owner.
|
class |
UpdateVolumeRequestContent |
class |
UpdateWorkspaceBindings |
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 |
class |
WorkspaceBindingsAPI
A catalog in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
interface |
WorkspaceBindingsService
A catalog in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AddInstanceProfile |
class |
AutoScale |
class |
AwsAttributes |
class |
AwsAvailability
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
class |
AzureAttributes |
class |
AzureAvailability
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
class |
CancelCommand |
class |
ChangeClusterOwner |
class |
ClientsTypes |
class |
CloudProviderNodeInfo |
class |
CloudProviderNodeStatus |
class |
ClusterAttributes |
class |
ClusterDetails |
class |
ClusterEvent |
class |
ClusterLibraryStatuses |
class |
ClusterLogConf |
class |
ClusterPoliciesAPI
Cluster policy limits the ability to configure clusters based on a set of rules.
|
interface |
ClusterPoliciesService
Cluster policy limits the ability to configure clusters based on a set of rules.
|
class |
ClustersAPI
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
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 |
interface |
ClustersService
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
class |
ClusterStatusRequest
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 |
ComputeSpec |
class |
ComputeSpecKind
The kind of compute described by this compute specification.
|
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 |
DataPlaneEventDetails |
class |
DataPlaneEventDetailsEventType
|
class |
DataSecurityMode
This describes an enum
|
class |
DbfsStorageInfo |
class |
DeleteCluster |
class |
DeleteGlobalInitScriptRequest
Delete init script
|
class |
DeleteInstancePool |
class |
DeletePolicy |
class |
DestroyContext |
class |
DiskSpec |
class |
DiskType |
class |
DiskTypeAzureDiskVolumeType |
class |
DiskTypeEbsVolumeType |
class |
DockerBasicAuth |
class |
DockerImage |
class |
EbsVolumeType
The type of EBS volumes that will be launched with this cluster.
|
class |
EditCluster |
class |
EditInstancePool |
class |
EditPolicy |
class |
EventDetails |
class |
EventDetailsCause
The cause of a change in target size.
|
class |
EventType |
class |
FleetLaunchTemplateOverride |
class |
FleetOnDemandOption |
class |
FleetOnDemandOptionAllocationStrategy
Only lowest-price and prioritized are allowed
|
class |
FleetSpotOption |
class |
FleetSpotOptionAllocationStrategy
lowest-price | diversified | capacity-optimized
|
class |
GcpAttributes |
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 |
GetClusterPolicyRequest
Get entity
|
class |
GetClusterRequest
Get cluster info
|
class |
GetEvents |
class |
GetEventsOrder
The order to list events in; either "ASC" or "DESC".
|
class |
GetEventsResponse |
class |
GetGlobalInitScriptRequest
Get an init script
|
class |
GetInstancePool |
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 |
InitScriptInfo |
class |
InstallLibraries |
class |
InstancePoolAndStats |
class |
InstancePoolAwsAttributes |
class |
InstancePoolAwsAttributesAvailability
Availability type used for the spot nodes.
|
class |
InstancePoolAzureAttributes |
class |
InstancePoolAzureAttributesAvailability
Shows the Availability type used for the spot nodes.
|
class |
InstancePoolFleetAttributes |
class |
InstancePoolGcpAttributes |
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
Current state of the instance pool.
|
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 |
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 |
class |
LibraryFullStatusStatus
Status of installing the library on the cluster.
|
class |
ListAllClusterLibraryStatusesResponse |
class |
ListAvailableZonesResponse |
class |
ListClusterPoliciesRequest
Get a cluster policy
|
class |
ListClustersRequest
List all clusters
|
class |
ListClustersResponse |
class |
ListGlobalInitScriptsResponse |
class |
ListInstancePools |
class |
ListInstanceProfilesResponse |
class |
ListNodeTypesResponse |
class |
ListPoliciesResponse |
class |
ListPolicyFamiliesRequest
List policy families
|
class |
ListPolicyFamiliesResponse |
class |
ListSortColumn |
class |
ListSortOrder |
class |
LogAnalyticsInfo |
class |
LogSyncStatus |
class |
MavenLibrary |
class |
NodeInstanceType |
class |
NodeType |
class |
PendingInstanceError |
class |
PermanentDeleteCluster |
class |
PinCluster |
class |
Policy |
class |
PolicyFamiliesAPI
View available policy families.
|
interface |
PolicyFamiliesService
View available policy families.
|
class |
PolicyFamily |
class |
PythonPyPiLibrary |
class |
RCranLibrary |
class |
RemoveInstanceProfile |
class |
ResizeCluster |
class |
RestartCluster |
class |
Results |
class |
ResultType |
class |
RuntimeEngine
Decides which runtime engine to be use, e.g.
|
class |
S3StorageInfo |
class |
SparkNode |
class |
SparkNodeAwsAttributes |
class |
SparkVersion |
class |
StartCluster |
class |
State
Current state of the cluster.
|
class |
TerminationReason |
class |
TerminationReasonCode
status code indicating why the cluster was terminated
|
class |
TerminationReasonType
type of the termination
|
class |
UninstallLibraries |
class |
UnpinCluster |
class |
WorkloadType |
class |
WorkspaceStorageInfo |
| Modifier and Type | Class and Description |
|---|---|
class |
AddBlock |
class |
Close |
class |
Create |
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 |
FileInfo |
class |
GetStatusRequest
Get the information of a file or directory
|
class |
ListDbfsRequest
List directory contents or file details
|
class |
ListStatusResponse |
class |
MkDirs |
class |
Move |
class |
Put |
class |
ReadDbfsRequest
Get the contents of a file
|
class |
ReadResponse |
| Modifier and Type | Class and Description |
|---|---|
class |
AccessControlRequest |
class |
AccessControlResponse |
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 |
ComplexValue |
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 |
DeleteServicePrincipalRequest
Delete a service principal
|
class |
DeleteUserRequest
Delete a user
|
class |
DeleteWorkspaceAssignmentRequest
Delete permissions assignment
|
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 |
GetPermissionLevelsRequest
Get permission levels
|
class |
GetPermissionLevelsResponse |
class |
GetPermissionRequest
Get object permissions
|
class |
GetRuleSetRequest
Get a rule set
|
class |
GetServicePrincipalRequest
Get service principal details
|
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.
|
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 |
ListServicePrincipalResponse |
class |
ListServicePrincipalsRequest
List service principals
|
class |
ListSortOrder |
class |
ListUsersRequest
List users
|
class |
ListUsersResponse |
class |
ListWorkspaceAssignmentRequest
Get permission assignments
|
class |
Name |
class |
ObjectPermissions |
class |
PartialUpdate |
class |
Patch |
class |
PatchOp
Type of patch operation.
|
class |
PatchSchema |
class |
Permission |
class |
PermissionAssignment |
class |
PermissionAssignments |
class |
PermissionLevel
Permission level
|
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 |
class |
PermissionsRequest |
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 |
class |
ResourceMeta |
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.
|
interface |
ServicePrincipalsService
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
UpdateRuleSetRequest |
class |
UpdateWorkspaceAssignments |
class |
User |
class |
UsersAPI
User identities recognized by Databricks and represented by email addresses.
|
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 |
BaseJob |
class |
BaseRun |
class |
CancelAllRuns |
class |
CancelRun |
class |
ClusterInstance |
class |
ClusterSpec |
class |
ConditionTask |
class |
ConditionTaskOp
* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands.
|
class |
Continuous |
class |
CreateJob |
class |
CreateResponse |
class |
CronSchedule |
class |
DbtOutput |
class |
DbtTask |
class |
DeleteJob |
class |
DeleteRun |
class |
ExportRunOutput |
class |
ExportRunRequest
Export and retrieve a job run
|
class |
FileArrivalTriggerConfiguration |
class |
Format |
class |
GetJobRequest
Get a single job
|
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 repository containing the notebooks used by this job's
notebook tasks.
|
class |
Job |
class |
JobCluster |
class |
JobCompute |
class |
JobEmailNotifications |
class |
JobNotificationSettings |
class |
JobParameter |
class |
JobParameterDefinition |
class |
JobRunAs
Write-only setting, available only in Create/Update/Reset and Submit calls.
|
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
This describes an enum
|
interface |
JobsService
The Jobs API allows you to create, edit, and delete jobs.
|
class |
ListJobsRequest
List jobs
|
class |
ListJobsResponse |
class |
ListRunsRequest
List job runs
|
class |
ListRunsResponse |
class |
ListRunsRunType
This describes an enum
|
class |
NotebookOutput |
class |
NotebookTask |
class |
PauseStatus |
class |
PipelineParams |
class |
PipelineTask |
class |
PythonWheelTask |
class |
RepairHistoryItem |
class |
RepairHistoryItemType
The repair history item type.
|
class |
RepairRun |
class |
RepairRunResponse |
class |
ResetJob |
class |
ResolvedConditionTaskValues |
class |
ResolvedDbtTaskValues |
class |
ResolvedNotebookTaskValues |
class |
ResolvedParamPairValues |
class |
ResolvedPythonWheelTaskValues |
class |
ResolvedRunJobTaskValues |
class |
ResolvedStringParamsValues |
class |
ResolvedValues |
class |
Run |
class |
RunConditionTask |
class |
RunConditionTaskOp
The condtion task operator.
|
class |
RunIf
This describes an enum
|
class |
RunJobOutput |
class |
RunJobTask |
class |
RunLifeCycleState
This describes an enum
|
class |
RunNow |
class |
RunNowResponse |
class |
RunOutput |
class |
RunParameters |
class |
RunResultState
This describes an enum
|
class |
RunState
The current state of the run.
|
class |
RunTask |
class |
RunType
This describes an enum
|
class |
Source |
class |
SparkJarTask |
class |
SparkPythonTask |
class |
SparkSubmitTask |
class |
SqlAlertOutput |
class |
SqlAlertState
The state of the SQL alert.
|
class |
SqlDashboardOutput |
class |
SqlDashboardWidgetOutput |
class |
SqlDashboardWidgetOutputStatus
The execution status of the SQL widget.
|
class |
SqlOutput |
class |
SqlOutputError |
class |
SqlQueryOutput |
class |
SqlStatementOutput |
class |
SqlTask |
class |
SqlTaskAlert |
class |
SqlTaskDashboard |
class |
SqlTaskFile |
class |
SqlTaskQuery |
class |
SqlTaskSubscription |
class |
SubmitRun |
class |
SubmitRunResponse |
class |
SubmitTask |
class |
Task |
class |
TaskDependency |
class |
TaskEmailNotifications |
class |
TaskNotificationSettings |
class |
TriggerEvaluation |
class |
TriggerHistory |
class |
TriggerInfo |
class |
TriggerSettings |
class |
TriggerType
This describes an enum
|
class |
UpdateJob |
class |
ViewItem |
class |
ViewsToExport
This describes an enum
|
class |
ViewType
This describes an enum
|
class |
Webhook |
class |
WebhookNotifications |
class |
WebhookNotificationsOnDurationWarningThresholdExceededItem |
| Modifier and Type | Class and Description |
|---|---|
class |
Activity
Activity recorded for the action.
|
class |
ActivityAction
This describes an enum
|
class |
ActivityType
This describes an enum
|
class |
ApproveTransitionRequest |
class |
ApproveTransitionRequestResponse |
class |
CommentActivityAction
This describes an enum
|
class |
CommentObject
Comment details.
|
class |
CreateComment |
class |
CreateCommentResponse |
class |
CreateExperiment |
class |
CreateExperimentResponse |
class |
CreateModelRequest |
class |
CreateModelResponse |
class |
CreateModelVersionRequest |
class |
CreateModelVersionResponse |
class |
CreateRegistryWebhook |
class |
CreateRun |
class |
CreateRunResponse |
class |
CreateTransitionRequest |
class |
CreateTransitionRequestResponse |
class |
CreateWebhookResponse |
class |
Dataset |
class |
DatasetInput |
class |
DeleteCommentRequest
Delete a comment
|
class |
DeleteExperiment |
class |
DeleteModelRequest
Delete a model
|
class |
DeleteModelTagRequest
Delete a model tag
|
class |
DeleteModelVersionRequest
Delete a model version.
|
class |
DeleteModelVersionTagRequest
Delete a model version tag
|
class |
DeleteRun |
class |
DeleteTag |
class |
DeleteTransitionRequestRequest
Delete a transition request
|
class |
DeleteTransitionRequestStage |
class |
DeleteWebhookRequest
Delete a webhook
|
class |
Experiment |
class |
ExperimentsAPI
Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an
experiment.
|
interface |
ExperimentsService
Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an
experiment.
|
class |
ExperimentTag |
class |
FileInfo |
class |
GetByNameRequest
Get metadata
|
class |
GetExperimentByNameResponse |
class |
GetExperimentRequest
Get an experiment
|
class |
GetHistoryRequest
Get history of a given metric within a run
|
class |
GetLatestVersionsRequest |
class |
GetLatestVersionsResponse |
class |
GetMetricHistoryResponse |
class |
GetModelRequest
Get model
|
class |
GetModelResponse |
class |
GetModelVersionDownloadUriRequest
Get a model version URI
|
class |
GetModelVersionDownloadUriResponse |
class |
GetModelVersionRequest
Get a model version
|
class |
GetModelVersionResponse |
class |
GetRunRequest
Get a run
|
class |
GetRunResponse |
class |
HttpUrlSpec |
class |
HttpUrlSpecWithoutSecret |
class |
InputTag |
class |
JobSpec |
class |
JobSpecWithoutSecret |
class |
ListArtifactsRequest
Get all artifacts
|
class |
ListArtifactsResponse |
class |
ListExperimentsRequest
List experiments
|
class |
ListExperimentsResponse |
class |
ListModelsRequest
List models
|
class |
ListModelsResponse |
class |
ListRegistryWebhooks |
class |
ListTransitionRequestsRequest
List transition requests
|
class |
ListTransitionRequestsResponse |
class |
ListWebhooksRequest
List registry webhooks
|
class |
LogBatch |
class |
LogInputs |
class |
LogMetric |
class |
LogModel |
class |
LogParam |
class |
Metric |
class |
Model |
class |
ModelDatabricks |
class |
ModelRegistryAPI
MLflow Model Registry is a centralized model repository and a UI and set of APIs that enable you
to manage the full lifecycle of MLflow Models.
|
interface |
ModelRegistryService
MLflow Model Registry is a centralized model repository and a UI and set of APIs that enable you
to manage the full lifecycle of MLflow Models.
|
class |
ModelTag |
class |
ModelVersion |
class |
ModelVersionDatabricks |
class |
ModelVersionStatus
Current status of `model_version`
|
class |
ModelVersionTag |
class |
Param |
class |
PermissionLevel
Permission level of the requesting user on the object.
|
class |
RegistryWebhook |
class |
RegistryWebhookEvent |
class |
RegistryWebhookStatus
This describes an enum
|
class |
RejectTransitionRequest |
class |
RejectTransitionRequestResponse |
class |
RenameModelRequest |
class |
RenameModelResponse |
class |
RestoreExperiment |
class |
RestoreRun |
class |
Run |
class |
RunData |
class |
RunInfo |
class |
RunInfoStatus
Current status of the run.
|
class |
RunInputs |
class |
RunTag |
class |
SearchExperiments |
class |
SearchExperimentsResponse |
class |
SearchExperimentsViewType
Qualifier for type of experiments to be returned.
|
class |
SearchModelsRequest
Search models
|
class |
SearchModelsResponse |
class |
SearchModelVersionsRequest
Searches model versions
|
class |
SearchModelVersionsResponse |
class |
SearchRuns |
class |
SearchRunsResponse |
class |
SearchRunsRunViewType
Whether to display only active, only deleted, or all runs.
|
class |
SetExperimentTag |
class |
SetModelTagRequest |
class |
SetModelVersionTagRequest |
class |
SetTag |
class |
Stage
This describes an enum
|
class |
Status
This describes an enum
|
class |
TestRegistryWebhook
Test webhook response object.
|
class |
TestRegistryWebhookRequest |
class |
TestRegistryWebhookResponse |
class |
TransitionModelVersionStageDatabricks |
class |
TransitionRequest
Transition request details.
|
class |
TransitionStageResponse |
class |
UpdateComment |
class |
UpdateCommentResponse |
class |
UpdateExperiment |
class |
UpdateModelRequest |
class |
UpdateModelVersionRequest |
class |
UpdateRegistryWebhook |
class |
UpdateRun |
class |
UpdateRunResponse |
class |
UpdateRunStatus
Updated status of the run.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CreateCustomAppIntegration |
class |
CreateCustomAppIntegrationOutput |
class |
CreateOAuthEnrollment |
class |
CreatePublishedAppIntegration |
class |
CreatePublishedAppIntegrationOutput |
class |
CreateServicePrincipalSecretRequest
Create service principal secret
|
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 |
DeleteCustomAppIntegrationRequest
Delete Custom OAuth App Integration
|
class |
DeletePublishedAppIntegrationRequest
Delete Published OAuth App Integration
|
class |
DeleteServicePrincipalSecretRequest
Delete service principal secret
|
class |
GetCustomAppIntegrationOutput |
class |
GetCustomAppIntegrationRequest
Get OAuth Custom App Integration
|
class |
GetCustomAppIntegrationsOutput |
class |
GetPublishedAppIntegrationOutput |
class |
GetPublishedAppIntegrationRequest
Get OAuth Published App Integration
|
class |
GetPublishedAppIntegrationsOutput |
class |
ListServicePrincipalSecretsRequest
List service principal secrets
|
class |
ListServicePrincipalSecretsResponse |
class |
OAuthEnrollmentAPI
These APIs enable administrators to enroll OAuth for their accounts, which is required for
adding/using any OAuth published/custom application integration.
|
interface |
OAuthEnrollmentService
These APIs enable administrators to enroll OAuth for their accounts, which is required for
adding/using any OAuth published/custom application integration.
|
class |
OAuthEnrollmentStatus |
class |
PublishedAppIntegrationAPI
These APIs enable administrators to manage published oauth app integrations, which is required
for adding/using Published OAuth App Integration like Tableau Cloud 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 Cloud for Databricks in AWS cloud.
|
class |
SecretInfo |
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 |
UpdateCustomAppIntegration |
class |
UpdatePublishedAppIntegration |
| Modifier and Type | Class and Description |
|---|---|
class |
CreatePipeline |
class |
CreatePipelineResponse |
class |
CronTrigger |
class |
DataPlaneId |
class |
DeletePipelineRequest
Delete a pipeline
|
class |
EditPipeline |
class |
ErrorDetail |
class |
EventLevel
The severity level of the event.
|
class |
FileLibrary |
class |
Filters |
class |
GetPipelineRequest
Get a pipeline
|
class |
GetPipelineResponse |
class |
GetPipelineResponseHealth
The health of a pipeline.
|
class |
GetUpdateRequest
Get a pipeline update
|
class |
GetUpdateResponse |
class |
ListPipelineEventsRequest
List pipeline events
|
class |
ListPipelineEventsResponse |
class |
ListPipelinesRequest
List pipelines
|
class |
ListPipelinesResponse |
class |
ListUpdatesRequest
List pipeline updates
|
class |
ListUpdatesResponse |
class |
MaturityLevel
Maturity level for EventDetails.
|
class |
NotebookLibrary |
class |
Origin |
class |
PipelineCluster |
class |
PipelineEvent |
class |
PipelineLibrary |
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 |
PipelineTrigger |
class |
ResetRequest
Reset a pipeline
|
class |
Sequencing |
class |
SerializedException |
class |
StackFrame |
class |
StartUpdate |
class |
StartUpdateCause |
class |
StartUpdateResponse |
class |
StopRequest
Stop a pipeline
|
class |
UpdateInfo |
class |
UpdateInfoCause
What triggered this update.
|
class |
UpdateInfoState
The update state.
|
class |
UpdateStateInfo |
class |
UpdateStateInfoState |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsCredentials |
class |
AwsKeyInfo |
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 |
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 |
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
This describes an enum
|
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 |
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 |
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
This describes an enum
|
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 |
BuildLogsRequest
Retrieve the logs associated with building the model's environment for a given serving endpoint's
served model.
|
class |
BuildLogsResponse |
class |
CreateServingEndpoint |
class |
DeleteServingEndpointRequest
Delete a serving endpoint
|
class |
EndpointCoreConfigInput |
class |
EndpointCoreConfigOutput |
class |
EndpointCoreConfigSummary |
class |
EndpointPendingConfig |
class |
EndpointState |
class |
EndpointStateConfigUpdate
The state of an endpoint's config update.
|
class |
EndpointStateReady
The state of an endpoint, indicating whether or not the endpoint is queryable.
|
class |
ExportMetricsRequest
Retrieve the metrics associated with a serving endpoint
|
class |
GetServingEndpointRequest
Get a single serving endpoint
|
class |
ListEndpointsResponse |
class |
LogsRequest
Retrieve the most recent log lines associated with a given serving endpoint's served model
|
class |
QueryEndpointResponse |
class |
QueryRequest
Query a serving endpoint with provided model input.
|
class |
Route |
class |
ServedModelInput |
class |
ServedModelOutput |
class |
ServedModelSpec |
class |
ServedModelState |
class |
ServedModelStateDeployment
The state of the served model deployment.
|
class |
ServerLogsResponse |
class |
ServingEndpoint |
class |
ServingEndpointDetailed |
class |
ServingEndpointDetailedPermissionLevel
The permission level of the principal making the request.
|
class |
ServingEndpointsAPI
The Serving Endpoints API allows you to create, update, and delete model serving endpoints.
|
interface |
ServingEndpointsService
The Serving Endpoints API allows you to create, update, and delete model serving endpoints.
|
class |
TrafficConfig |
| Modifier and Type | Class and Description |
|---|---|
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 |
AccountNetworkPolicyAPI
Network policy is a set of rules that defines what can be accessed from your Databricks network.
|
class |
AccountNetworkPolicyMessage |
interface |
AccountNetworkPolicyService
Network policy is a set of rules that defines what can be accessed from your Databricks network.
|
class |
AccountSettingsAPI
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
interface |
AccountSettingsService
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
class |
CreateIpAccessList |
class |
CreateIpAccessListResponse |
class |
CreateOboTokenRequest |
class |
CreateOboTokenResponse |
class |
CreateTokenRequest |
class |
CreateTokenResponse |
class |
DeleteAccountIpAccessListRequest
Delete access list
|
class |
DeleteAccountNetworkPolicyRequest
Delete Account Network Policy
|
class |
DeleteAccountNetworkPolicyResponse |
class |
DeleteIpAccessListRequest
Delete access list
|
class |
DeletePersonalComputeSettingRequest
Delete Personal Compute setting
|
class |
DeletePersonalComputeSettingResponse |
class |
DeleteTokenManagementRequest
Delete a token
|
class |
FetchIpAccessListResponse |
class |
GetAccountIpAccessListRequest
Get IP access list
|
class |
GetIpAccessListRequest
Get access list
|
class |
GetIpAccessListResponse |
class |
GetIpAccessListsResponse |
class |
GetStatusRequest
Check configuration status
|
class |
GetTokenManagementRequest
Get token info
|
class |
IpAccessListInfo |
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 |
ListTokenManagementRequest
List all tokens
|
class |
ListTokensResponse |
class |
ListType
This describes an enum
|
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.
|
class |
PersonalComputeSetting |
class |
PublicTokenInfo |
class |
ReadAccountNetworkPolicyRequest
Get Account Network Policy
|
class |
ReadPersonalComputeSettingRequest
Get Personal Compute setting
|
class |
ReplaceIpAccessList |
class |
RevokeTokenRequest |
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 |
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 |
UpdateAccountNetworkPolicyRequest
Update Account Network Policy
|
class |
UpdateIpAccessList |
class |
UpdatePersonalComputeSettingRequest
Update Personal Compute setting
|
class |
WorkspaceConfAPI
This API allows updating known workspace settings for advanced users.
|
interface |
WorkspaceConfService
This API allows updating known workspace settings for advanced users.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AuthenticationType
The delta sharing authentication type.
|
class |
CentralCleanRoomInfo |
class |
CleanRoomAssetInfo |
class |
CleanRoomCatalog |
class |
CleanRoomCatalogUpdate |
class |
CleanRoomCollaboratorInfo |
class |
CleanRoomInfo |
class |
CleanRoomNotebookInfo |
class |
CleanRoomsAPI
A clean room is a secure, privacy-protecting environment where two or more parties can share
sensitive enterprise data, including customer data, for measurements, insights, activation and
other use cases.
|
interface |
CleanRoomsService
A clean room is a secure, privacy-protecting environment where two or more parties can share
sensitive enterprise data, including customer data, for measurements, insights, activation and
other use cases.
|
class |
CleanRoomTableInfo |
class |
ColumnInfo |
class |
ColumnMask |
class |
ColumnTypeName
Name of type (INT, STRUCT, MAP, etc.).
|
class |
CreateCleanRoom |
class |
CreateProvider |
class |
CreateRecipient |
class |
CreateShare |
class |
DeleteCleanRoomRequest
Delete a clean room
|
class |
DeleteProviderRequest
Delete a provider
|
class |
DeleteRecipientRequest
Delete a share recipient
|
class |
DeleteShareRequest
Delete a share
|
class |
GetActivationUrlInfoRequest
Get a share activation URL
|
class |
GetCleanRoomRequest
Get a clean room
|
class |
GetProviderRequest
Get a provider
|
class |
GetRecipientRequest
Get a share recipient
|
class |
GetRecipientSharePermissionsResponse |
class |
GetShareRequest
Get a share
|
class |
IpAccessList |
class |
ListCleanRoomsResponse |
class |
ListProviderSharesResponse |
class |
ListProvidersRequest
List providers
|
class |
ListProvidersResponse |
class |
ListRecipientsRequest
List share recipients
|
class |
ListRecipientsResponse |
class |
ListSharesRequest
List shares by Provider
|
class |
ListSharesResponse |
class |
Partition |
class |
PartitionValue |
class |
PartitionValueOp
The operator to apply for the value.
|
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 |
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 |
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 |
SharedDataObjectHistoryDataSharingStatus
Whether to enable or disable sharing of data history.
|
class |
SharedDataObjectStatus
One of: **ACTIVE**, **PERMISSION_DENIED**.
|
class |
SharedDataObjectUpdate |
class |
SharedDataObjectUpdateAction
One of: **ADD**, **REMOVE**, **UPDATE**.
|
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 |
UpdateCleanRoom |
class |
UpdateProvider |
class |
UpdateRecipient |
class |
UpdateShare |
class |
UpdateSharePermissions |
| Modifier and Type | Class and Description |
|---|---|
class |
AccessControl |
class |
Alert |
class |
AlertOptions
Alert configuration options.
|
class |
AlertQuery |
class |
AlertsAPI
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
State of the alert.
|
class |
CancelExecutionRequest
Cancel statement execution
|
class |
Channel |
class |
ChannelInfo
Channel information for the SQL warehouse at the time of query execution
|
class |
ChannelName |
class |
ChunkInfo
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 |
ColumnInfo |
class |
ColumnInfoTypeName
Name of type (INT, STRUCT, MAP, and so on)
|
class |
CreateAlert |
class |
CreateDashboardRequest
Create a dashboard object
|
class |
CreateWarehouseRequest |
class |
CreateWarehouseRequestWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
CreateWarehouseResponse |
class |
Dashboard
A JSON representing a dashboard containing widgets of visualizations and text boxes.
|
class |
DashboardOptions |
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 |
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 |
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 |
DeleteAlertRequest
Delete an alert
|
class |
DeleteDashboardRequest
Remove a dashboard
|
class |
DeleteQueryRequest
Delete a query
|
class |
DeleteWarehouseRequest
Delete a warehouse
|
class |
Disposition
The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`.
|
class |
EditAlert |
class |
EditWarehouseRequest |
class |
EditWarehouseRequestWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
EndpointConfPair |
class |
EndpointHealth |
class |
EndpointInfo |
class |
EndpointInfoWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
EndpointTagPair |
class |
EndpointTags |
class |
ExecuteStatementRequest |
class |
ExecuteStatementResponse |
class |
ExternalLink |
class |
Format
Statement execution supports three result formats: `JSON_ARRAY` (default), `ARROW_STREAM`, and
`CSV`.
|
class |
GetAlertRequest
Get an alert
|
class |
GetDashboardRequest
Retrieve a definition
|
class |
GetDbsqlPermissionRequest
Get object ACL
|
class |
GetQueryRequest
Get a query definition.
|
class |
GetResponse |
class |
GetStatementRequest
Get status, manifest, and result first chunk
|
class |
GetStatementResponse |
class |
GetStatementResultChunkNRequest
Get result chunk by index
|
class |
GetWarehouseRequest
Get warehouse info
|
class |
GetWarehouseResponse |
class |
GetWarehouseResponseWarehouseType
Warehouse type: `PRO` or `CLASSIC`.
|
class |
GetWorkspaceWarehouseConfigResponse |
class |
GetWorkspaceWarehouseConfigResponseSecurityPolicy
Security policy for warehouses
|
class |
ListDashboardsRequest
Get dashboard objects
|
class |
ListOrder |
class |
ListQueriesRequest
Get a list of queries
|
class |
ListQueriesResponse |
class |
ListQueryHistoryRequest
List Queries
|
class |
ListResponse |
class |
ListWarehousesRequest
List warehouses
|
class |
ListWarehousesResponse |
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
This describes an enum
|
class |
PlansState
Whether plans exist for the execution, or the reason why they are missing
|
class |
QueriesAPI
These endpoints are used for CRUD operations on query definitions.
|
interface |
QueriesService
These endpoints are used for CRUD operations on query definitions.
|
class |
Query |
class |
QueryEditContent |
class |
QueryFilter
A filter to limit query history results.
|
class |
QueryHistoryAPI
Access the history of queries through SQL warehouses.
|
interface |
QueryHistoryService
Access the history of queries through SQL warehouses.
|
class |
QueryInfo |
class |
QueryList |
class |
QueryMetrics
Metrics about query execution.
|
class |
QueryOptions |
class |
QueryPostContent |
class |
QueryStatementType
Type of statement for this query
|
class |
QueryStatus
This describes an enum
|
class |
RepeatedEndpointConfPairs |
class |
RestoreDashboardRequest
Restore a dashboard
|
class |
RestoreQueryRequest
Restore a query
|
class |
ResultData
Result data chunks are delivered in either the `chunk` field when using `INLINE` disposition, or
in the `external_link` field when using `EXTERNAL_LINKS` disposition.
|
class |
ResultManifest
The result manifest provides schema and metadata for the result set.
|
class |
ResultSchema
Schema is an ordered list of column descriptions.
|
class |
ServiceError |
class |
ServiceErrorCode |
class |
SetRequest
Set object ACL
|
class |
SetResponse |
class |
SetWorkspaceWarehouseConfigRequest |
class |
SetWorkspaceWarehouseConfigRequestSecurityPolicy
Security policy for warehouses
|
class |
SpotInstancePolicy
Configurations whether the warehouse should use spot instances.
|
class |
StartRequest
Start a warehouse
|
class |
State
State of the warehouse
|
class |
StatementExecutionAPI
The SQL Statement Execution API manages the execution of arbitrary SQL statements and the
fetching of result data.
|
interface |
StatementExecutionService
The SQL Statement Execution API manages the execution of arbitrary SQL statements and the
fetching of result data.
|
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
Status response includes execution state and if relevant, error information.
|
class |
Status
Health status of the warehouse.
|
class |
StopRequest
Stop a warehouse
|
class |
Success |
class |
SuccessMessage |
class |
TerminationReason |
class |
TerminationReasonCode
status code indicating why the cluster was terminated
|
class |
TerminationReasonType
type of the termination
|
class |
TimeoutAction
When in synchronous mode with `wait_timeout > 0s` it determines the action taken when the timeout
is reached:
|
class |
TimeRange |
class |
TransferOwnershipObjectId |
class |
TransferOwnershipRequest
Transfer object ownership
|
class |
User |
class |
Visualization
The visualization description API changes frequently and is unsupported.
|
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 |
| Modifier and Type | Class and Description |
|---|---|
class |
AclItem |
class |
AclPermission |
class |
AzureKeyVaultSecretScopeMetadata |
class |
CreateCredentials |
class |
CreateCredentialsResponse |
class |
CreateRepo |
class |
CreateScope |
class |
CredentialInfo |
class |
Delete |
class |
DeleteAcl |
class |
DeleteGitCredentialRequest
Delete a credential
|
class |
DeleteRepoRequest
Delete a repo
|
class |
DeleteScope |
class |
DeleteSecret |
class |
ExportFormat |
class |
ExportRequest
Export a workspace object
|
class |
ExportResponse |
class |
GetAclRequest
Get secret ACL details
|
class |
GetCredentialsResponse |
class |
GetGitCredentialRequest
Get a credential entry
|
class |
GetRepoRequest
Get a repo
|
class |
GetStatusRequest
Get status
|
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
This specifies the format of the file to be imported.
|
class |
Language
The language of the object.
|
class |
ListAclsRequest
Lists ACLs
|
class |
ListAclsResponse |
class |
ListReposRequest
Get repos
|
class |
ListReposResponse |
class |
ListResponse |
class |
ListScopesResponse |
class |
ListSecretsRequest
List secret keys
|
class |
ListSecretsResponse |
class |
ListWorkspaceRequest
List contents
|
class |
Mkdirs |
class |
ObjectInfo |
class |
ObjectType
The type of the object in workspace.
|
class |
PutAcl |
class |
PutSecret |
class |
RepoInfo |
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 |
class |
SparseCheckoutUpdate |
class |
UpdateCredentials |
class |
UpdateRepo |
class |
WorkspaceAPI
The Workspace API allows you to list, import, export, and delete notebooks and folders.
|
interface |
WorkspaceService
The Workspace API allows you to list, import, export, and delete notebooks and folders.
|
Copyright © 2023. All rights reserved.