All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
| Class |
Description |
| AccessControl |
|
| AccessControlRequest |
|
| AccessControlResponse |
|
| AccountAccessControlAPI |
These APIs manage access rules on resources in an account.
|
| AccountAccessControlProxyAPI |
These APIs manage access rules on resources in an account.
|
| AccountAccessControlProxyService |
These APIs manage access rules on resources in an account.
|
| AccountAccessControlService |
These APIs manage access rules on resources in an account.
|
| AccountClient |
Entry point for accessing Databricks account-level APIs
|
| AccountGroupsAPI |
Groups simplify identity management, making it easier to assign access to Databricks account,
data, and other securable objects.
|
| AccountGroupsService |
Groups simplify identity management, making it easier to assign access to Databricks account,
data, and other securable objects.
|
| AccountIpAccessListsAPI |
The Accounts IP Access List API enables account admins to configure IP access lists for access to
the account console.
|
| AccountIpAccessListsService |
The Accounts IP Access List API enables account admins to configure IP access lists for access to
the account console.
|
| AccountMetastoreAssignmentsAPI |
These APIs manage metastore assignments to a workspace.
|
| AccountMetastoreAssignmentsService |
These APIs manage metastore assignments to a workspace.
|
| AccountMetastoresAPI |
These APIs manage Unity Catalog metastores for an account.
|
| AccountMetastoresService |
These APIs manage Unity Catalog metastores for an account.
|
| AccountsCreateMetastore |
|
| AccountsCreateMetastoreAssignment |
|
| AccountsCreateStorageCredential |
|
| AccountServicePrincipalsAPI |
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
| AccountServicePrincipalsService |
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
| AccountSettingsAPI |
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
| AccountSettingsService |
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
| AccountsMetastoreAssignment |
|
| AccountsMetastoreInfo |
|
| AccountStorageCredentialsAPI |
These APIs manage storage credentials for a particular metastore.
|
| AccountStorageCredentialsService |
These APIs manage storage credentials for a particular metastore.
|
| AccountsUpdateMetastore |
|
| AccountsUpdateMetastoreAssignment |
|
| AccountsUpdateStorageCredential |
|
| AccountUsersAPI |
User identities recognized by Databricks and represented by email addresses.
|
| AccountUsersService |
User identities recognized by Databricks and represented by email addresses.
|
| AclItem |
|
| AclPermission |
|
| Activity |
Activity recorded for the action.
|
| ActivityAction |
This describes an enum
|
| ActivityType |
This describes an enum
|
| AddBlock |
|
| AddInstanceProfile |
|
| Alert |
|
| AlertOptions |
Alert configuration options.
|
| AlertQuery |
|
| AlertsAPI |
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertsService |
The alerts API can be used to perform CRUD operations on alerts.
|
| AlertState |
State of the alert.
|
| ApiClient |
Simplified REST API client with retries, JSON POJO SerDe through Jackson and exception POJO
guessing
|
| ApiErrorBody |
The union of all JSON error responses from the Databricks APIs, not including HTML responses.
|
| ApiErrors |
Helper methods for inspecting the response and errors thrown during API requests.
|
| ApproveTransitionRequest |
|
| ApproveTransitionRequestResponse |
|
| AuthenticationType |
The delta sharing authentication type.
|
| AuthParameterPosition |
Options for where authentication parameters can be provided in a request.
|
| AutoScale |
|
| AwsAttributes |
|
| AwsAvailability |
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
| AwsCredentials |
|
| AwsIamRole |
|
| AwsKeyInfo |
|
| AzureAttributes |
|
| AzureAvailability |
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
| AzureCliCredentialsProvider |
|
| AzureEnvironment |
The set of endpoints within a single Azure authentication boundary.
|
| AzureKeyVaultSecretScopeMetadata |
|
| AzureManagedIdentity |
|
| AzureServicePrincipal |
|
| AzureServicePrincipalCredentialsProvider |
Adds refreshed Azure Active Directory (AAD) Service Principal OAuth tokens to every request,
while automatically resolving different Azure environment endpoints.
|
| AzureUtils |
|
| BaseJob |
|
| BaseRun |
|
| BasicCredentialsProvider |
|
| BillableUsageAPI |
This API allows you to download billable usage logs for the specified account and date range.
|
| BillableUsageService |
This API allows you to download billable usage logs for the specified account and date range.
|
| Budget |
Budget configuration to be created.
|
| BudgetAlert |
|
| BudgetList |
List of budgets.
|
| BudgetsAPI |
These APIs manage budget configuration including notifications for exceeding a budget for a
period.
|
| BudgetsService |
These APIs manage budget configuration including notifications for exceeding a budget for a
period.
|
| BudgetWithStatus |
Budget configuration with daily status.
|
| BudgetWithStatusStatusDailyItem |
|
| BuildLogsRequest |
Retrieve the logs associated with building the model's environment for a given serving endpoint's
served model.
|
| BuildLogsResponse |
|
| CancelAllRuns |
|
| CancelCommand |
|
| CancelExecutionRequest |
Cancel statement execution
|
| CancelRun |
|
| CatalogInfo |
|
| CatalogsAPI |
A catalog is the first layer of Unity Catalog’s three-level namespace.
|
| CatalogsService |
A catalog is the first layer of Unity Catalog’s three-level namespace.
|
| CatalogType |
The type of the catalog.
|
| CentralCleanRoomInfo |
|
| ChangeClusterOwner |
|
| Channel |
|
| ChannelInfo |
Channel information for the SQL warehouse at the time of query execution
|
| ChannelName |
Name of the channel
|
| 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.
|
| CleanRoomAssetInfo |
|
| CleanRoomCatalog |
|
| CleanRoomCatalogUpdate |
|
| CleanRoomCollaboratorInfo |
|
| CleanRoomInfo |
|
| CleanRoomNotebookInfo |
|
| 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.
|
| 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.
|
| CleanRoomTableInfo |
|
| ClientCredentials |
An implementation of RefreshableTokenSource implementing the client_credentials OAuth grant type.
|
| ClientCredentials.Builder |
|
| ClientsTypes |
|
| CliTokenSource |
|
| Close |
|
| CloudProviderNodeInfo |
|
| CloudProviderNodeStatus |
|
| CloudResourceContainer |
The general workspace configurations that are specific to cloud providers.
|
| ClusterAttributes |
|
| ClusterDetails |
|
| ClusterEvent |
|
| ClusterInstance |
|
| ClusterLibraryStatuses |
|
| ClusterLogConf |
|
| ClusterPoliciesAPI |
Cluster policy limits the ability to configure clusters based on a set of rules.
|
| ClusterPoliciesService |
Cluster policy limits the ability to configure clusters based on a set of rules.
|
| ClustersAPI |
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
| ClustersExt |
|
| ClusterSize |
|
| ClusterSource |
Determines whether the cluster was created by a user through the UI, created by the Databricks
Jobs Scheduler, or through an API request.
|
| ClusterSpec |
|
| ClusterSpec |
|
| ClustersService |
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
| ClusterStatusRequest |
Get status
|
| ColumnInfo |
|
| ColumnInfo |
|
| ColumnInfo |
|
| ColumnInfoTypeName |
Name of type (INT, STRUCT, MAP, and so on)
|
| ColumnMask |
|
| ColumnMask |
|
| ColumnTypeName |
Name of type (INT, STRUCT, MAP, etc.).
|
| ColumnTypeName |
Name of type (INT, STRUCT, MAP, etc.).
|
| Command |
|
| CommandExecutionAPI |
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
|
| CommandExecutionService |
This API allows execution of Python, Scala, SQL, or R commands on running Databricks Clusters.
|
| CommandStatus |
|
| CommandStatusRequest |
Get command info
|
| CommandStatusResponse |
|
| CommentActivityAction |
This describes an enum
|
| CommentObject |
Comment details.
|
| CommonsHttpClient |
|
| ComplexValue |
|
| ComputeSpec |
|
| ComputeSpecKind |
The kind of compute described by this compute specification.
|
| ConditionTask |
|
| ConditionTaskOp |
* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands.
|
| ConfigAttribute |
|
| ConfigLoader |
|
| ConnectionInfo |
|
| ConnectionsAPI |
Connections allow for creating a connection to an external data source.
|
| ConnectionsService |
Connections allow for creating a connection to an external data source.
|
| ConnectionType |
The type of connection.
|
| Consent |
Consent provides a mechanism to retrieve an authorization code and exchange it for an OAuth token
using the Authorization Code + PKCE flow.
|
| Consent.Builder |
|
| ContextStatus |
|
| ContextStatusRequest |
Get status
|
| ContextStatusResponse |
|
| Continuous |
|
| Create |
|
| CreateAlert |
|
| CreateAwsKeyInfo |
|
| CreateCatalog |
|
| CreateCleanRoom |
|
| CreateCluster |
|
| CreateClusterResponse |
|
| CreateComment |
|
| CreateCommentResponse |
|
| CreateConnection |
|
| CreateContext |
|
| CreateCredentialAwsCredentials |
|
| CreateCredentialRequest |
|
| CreateCredentials |
|
| CreateCredentialsResponse |
|
| CreateCredentialStsRole |
|
| CreateCustomAppIntegration |
|
| CreateCustomAppIntegrationOutput |
|
| CreateCustomerManagedKeyRequest |
|
| Created |
|
| CreateDashboardRequest |
Create a dashboard object
|
| CreateExperiment |
|
| CreateExperimentResponse |
|
| CreateExternalLocation |
|
| CreateFunction |
|
| CreateFunctionParameterStyle |
Function parameter style.
|
| CreateFunctionRoutineBody |
Function language.
|
| CreateFunctionSecurityType |
Function security type.
|
| CreateFunctionSqlDataAccess |
Function SQL data access.
|
| CreateGcpKeyInfo |
|
| CreateInstancePool |
|
| CreateInstancePoolResponse |
|
| CreateIpAccessList |
|
| CreateIpAccessListResponse |
|
| CreateJob |
|
| CreateLogDeliveryConfigurationParams |
|
| CreateMetastore |
|
| CreateMetastoreAssignment |
|
| CreateMetastoreAssignmentsResponseItem |
|
| CreateModelRequest |
|
| CreateModelResponse |
|
| CreateModelVersionRequest |
|
| CreateModelVersionResponse |
|
| CreateNetworkRequest |
|
| CreateOAuthEnrollment |
|
| CreateOboTokenRequest |
|
| CreateOboTokenResponse |
|
| CreatePipeline |
|
| CreatePipelineResponse |
|
| CreatePolicy |
|
| CreatePolicyResponse |
|
| CreateProvider |
|
| CreatePublishedAppIntegration |
|
| CreatePublishedAppIntegrationOutput |
|
| CreateRecipient |
|
| CreateRegistryWebhook |
|
| CreateRepo |
|
| CreateResponse |
|
| CreateResponse |
|
| CreateResponse |
|
| CreateRun |
|
| CreateRunResponse |
|
| CreateSchema |
|
| CreateScope |
|
| CreateServicePrincipalSecretRequest |
Create service principal secret
|
| CreateServicePrincipalSecretResponse |
|
| CreateServingEndpoint |
|
| CreateShare |
|
| CreateStorageConfigurationRequest |
|
| CreateStorageCredential |
|
| CreateTableConstraint |
|
| CreateTokenRequest |
|
| CreateTokenResponse |
|
| CreateTransitionRequest |
|
| CreateTransitionRequestResponse |
|
| CreateVolumeRequestContent |
|
| CreateVpcEndpointRequest |
|
| CreateWarehouseRequest |
|
| CreateWarehouseRequestWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| CreateWarehouseResponse |
|
| CreateWebhookResponse |
|
| CreateWorkspaceRequest |
|
| Credential |
|
| CredentialInfo |
|
| CredentialsAPI |
These APIs manage credential configurations for this workspace.
|
| CredentialsProvider |
|
| CredentialsService |
These APIs manage credential configurations for this workspace.
|
| CredentialType |
The type of credential.
|
| CronSchedule |
|
| CronTrigger |
|
| CurrentUserAPI |
This API allows retrieving information about currently authenticated user or service principal.
|
| CurrentUserService |
This API allows retrieving information about currently authenticated user or service principal.
|
| CurrentWorkspaceBindings |
Currently assigned workspaces
|
| 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.
|
| 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.
|
| CustomerFacingGcpCloudResourceContainer |
The general workspace configurations that are specific to Google Cloud.
|
| CustomerManagedKey |
|
| Dashboard |
A JSON representing a dashboard containing widgets of visualizations and text boxes.
|
| DashboardOptions |
|
| DashboardsAPI |
In general, there is little need to modify dashboards using the API.
|
| DashboardsService |
In general, there is little need to modify dashboards using the API.
|
| DatabricksCliCredentialsProvider |
|
| DatabricksConfig |
|
| DatabricksError |
The result of checking whether ApiClient should retry a request.
|
| DatabricksException |
|
| DatabricksGcpServiceAccountResponse |
|
| DataPlaneEventDetails |
|
| DataPlaneEventDetailsEventType |
|
| DataPlaneId |
|
| DataSecurityMode |
This describes an enum
|
| Dataset |
|
| DatasetInput |
|
| DataSource |
A JSON object representing a DBSQL data source / SQL warehouse.
|
| DataSourceFormat |
Data source format
|
| DataSourcesAPI |
This API is provided to assist you in making new query objects.
|
| DataSourcesService |
This API is provided to assist you in making new query objects.
|
| 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.
|
| DbfsExt |
Utility methods for the DBFS API.
|
| 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.
|
| DbfsStorageInfo |
|
| DbsqlPermissionsAPI |
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
| DbsqlPermissionsService |
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
| DbtOutput |
|
| DbtTask |
|
| DefaultCredentialsProvider |
|
| Delete |
|
| Delete |
|
| DeleteAccountGroupRequest |
Delete a group
|
| DeleteAccountIpAccessListRequest |
Delete access list
|
| DeleteAccountMetastoreAssignmentRequest |
Delete a metastore assignment
|
| DeleteAccountMetastoreRequest |
Delete a metastore
|
| DeleteAccountServicePrincipalRequest |
Delete a service principal
|
| DeleteAccountStorageCredentialRequest |
Delete a storage credential
|
| DeleteAccountUserRequest |
Delete a user
|
| DeleteAcl |
|
| DeleteAlertRequest |
Delete an alert
|
| DeleteBudgetRequest |
Delete budget
|
| DeleteCatalogRequest |
Delete a catalog
|
| DeleteCleanRoomRequest |
Delete a clean room
|
| DeleteCluster |
|
| DeleteCommentRequest |
Delete a comment
|
| DeleteConnectionRequest |
Delete a connection
|
| DeleteCredentialRequest |
Delete credential configuration
|
| DeleteCustomAppIntegrationRequest |
Delete Custom OAuth App Integration
|
| DeleteDashboardRequest |
Remove a dashboard
|
| DeleteEncryptionKeyRequest |
Delete encryption key configuration
|
| DeleteExperiment |
|
| DeleteExternalLocationRequest |
Delete an external location
|
| DeleteFunctionRequest |
Delete a function
|
| DeleteGitCredentialRequest |
Delete a credential
|
| DeleteGlobalInitScriptRequest |
Delete init script
|
| DeleteGroupRequest |
Delete a group
|
| DeleteInstancePool |
|
| DeleteIpAccessListRequest |
Delete access list
|
| DeleteJob |
|
| DeleteMetastoreRequest |
Delete a metastore
|
| DeleteModelRequest |
Delete a model
|
| DeleteModelTagRequest |
Delete a model tag
|
| DeleteModelVersionRequest |
Delete a model version.
|
| DeleteModelVersionTagRequest |
Delete a model version tag
|
| DeleteNetworkRequest |
Delete a network configuration
|
| DeletePersonalComputeSettingRequest |
Delete Personal Compute setting
|
| DeletePersonalComputeSettingResponse |
|
| DeletePipelineRequest |
Delete a pipeline
|
| DeletePolicy |
|
| DeletePrivateAccesRequest |
Delete a private access settings object
|
| DeleteProviderRequest |
Delete a provider
|
| DeletePublishedAppIntegrationRequest |
Delete Published OAuth App Integration
|
| DeleteQueryRequest |
Delete a query
|
| DeleteRecipientRequest |
Delete a share recipient
|
| DeleteRepoRequest |
Delete a repo
|
| DeleteRun |
|
| DeleteRun |
|
| DeleteSchemaRequest |
Delete a schema
|
| DeleteScope |
|
| DeleteSecret |
|
| DeleteServicePrincipalRequest |
Delete a service principal
|
| DeleteServicePrincipalSecretRequest |
Delete service principal secret
|
| DeleteServingEndpointRequest |
Delete a serving endpoint
|
| DeleteShareRequest |
Delete a share
|
| DeleteStorageCredentialRequest |
Delete a credential
|
| DeleteStorageRequest |
Delete storage configuration
|
| DeleteTableConstraintRequest |
Delete a table constraint
|
| DeleteTableRequest |
Delete a table
|
| DeleteTag |
|
| DeleteTokenManagementRequest |
Delete a token
|
| DeleteTransitionRequestRequest |
Delete a transition request
|
| DeleteTransitionRequestStage |
|
| DeleteUserRequest |
Delete a user
|
| DeleteVolumeRequest |
Delete a Volume
|
| DeleteVpcEndpointRequest |
Delete VPC endpoint configuration
|
| DeleteWarehouseRequest |
Delete a warehouse
|
| DeleteWebhookRequest |
Delete a webhook
|
| DeleteWorkspaceAssignmentRequest |
Delete permissions assignment
|
| DeleteWorkspaceRequest |
Delete a workspace
|
| DeliveryStatus |
This describes an enum
|
| DeltaRuntimePropertiesKvPairs |
Properties pertaining to the current state of the delta table as given by the commit server.
|
| Dependency |
A dependency of a SQL object.
|
| DestroyContext |
|
| DisableRequest |
Disable a system schema
|
| DisableSchemaName |
|
| DiskSpec |
|
| DiskType |
|
| DiskTypeAzureDiskVolumeType |
|
| DiskTypeEbsVolumeType |
|
| Disposition |
The fetch disposition provides two modes of fetching results: `INLINE` and `EXTERNAL_LINKS`.
|
| DockerBasicAuth |
|
| DockerImage |
|
| DownloadRequest |
Return billable usage logs
|
| EbsVolumeType |
The type of EBS volumes that will be launched with this cluster.
|
| EditAlert |
|
| EditCluster |
|
| EditInstancePool |
|
| EditPipeline |
|
| EditPolicy |
|
| EditWarehouseRequest |
|
| EditWarehouseRequestWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| EffectiveAutoMaintenanceFlag |
|
| EffectiveAutoMaintenanceFlagInheritedFromType |
The type of the object from which the flag was inherited.
|
| EffectivePermissionsList |
|
| EffectivePrivilege |
|
| EffectivePrivilegeAssignment |
|
| EnableAutoMaintenance |
Whether auto maintenance should be enabled for this object and objects under it.
|
| EnableRequest |
Enable a system schema
|
| EnableSchemaName |
|
| EncryptionKeysAPI |
These APIs manage encryption key configurations for this workspace (optional).
|
| EncryptionKeysService |
These APIs manage encryption key configurations for this workspace (optional).
|
| EndpointConfPair |
|
| EndpointCoreConfigInput |
|
| EndpointCoreConfigOutput |
|
| EndpointCoreConfigSummary |
|
| EndpointHealth |
|
| EndpointInfo |
|
| EndpointInfoWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| EndpointPendingConfig |
|
| EndpointState |
|
| EndpointStateConfigUpdate |
The state of an endpoint's config update.
|
| EndpointStateReady |
The state of an endpoint, indicating whether or not the endpoint is queryable.
|
| EndpointTagPair |
|
| EndpointTags |
|
| EndpointUseCase |
This enumeration represents the type of Databricks VPC [endpoint service] that was used when
creating this VPC endpoint.
|
| ErrorDetail |
|
| ErrorType |
The AWS resource associated with this error: credentials, VPC, subnet, security group, or network
ACL.
|
| EventDetails |
|
| EventDetailsCause |
The cause of a change in target size.
|
| EventLevel |
The severity level of the event.
|
| EventType |
|
| ExecuteStatementRequest |
|
| ExecuteStatementResponse |
|
| Experiment |
|
| ExperimentsAPI |
Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an
experiment.
|
| ExperimentsService |
Experiments are the primary unit of organization in MLflow; all MLflow runs belong to an
experiment.
|
| ExperimentTag |
|
| ExportFormat |
|
| ExportMetricsRequest |
Retrieve the metrics associated with a serving endpoint
|
| ExportRequest |
Export a workspace object
|
| ExportResponse |
|
| ExportRunOutput |
|
| ExportRunRequest |
Export and retrieve a job run
|
| ExternalBrowserCredentialsProvider |
A CredentialsProvider which implements the Authorization Code + PKCE flow by opening a
browser for the user to authorize the application.
|
| ExternalLink |
|
| ExternalLocationInfo |
|
| 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.
|
| 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.
|
| FetchIpAccessListResponse |
|
| FileArrivalTriggerConfiguration |
|
| FileInfo |
|
| FileInfo |
|
| FileLibrary |
|
| Filters |
|
| FleetLaunchTemplateOverride |
|
| FleetOnDemandOption |
|
| FleetOnDemandOptionAllocationStrategy |
Only lowest-price and prioritized are allowed
|
| FleetSpotOption |
|
| FleetSpotOptionAllocationStrategy |
lowest-price | diversified | capacity-optimized
|
| ForeignKeyConstraint |
|
| Format |
|
| Format |
Statement execution supports three result formats: `JSON_ARRAY` (default), `ARROW_STREAM`, and
`CSV`.
|
| FormRequest |
|
| FunctionDependency |
A function that is dependent on a SQL object.
|
| FunctionInfo |
|
| FunctionInfoParameterStyle |
Function parameter style.
|
| FunctionInfoRoutineBody |
Function language.
|
| FunctionInfoSecurityType |
Function security type.
|
| FunctionInfoSqlDataAccess |
Function SQL data access.
|
| FunctionParameterInfo |
|
| FunctionParameterMode |
The mode of the function parameter.
|
| FunctionParameterType |
The type of function parameter.
|
| FunctionsAPI |
Functions implement User-Defined Functions (UDFs) in Unity Catalog.
|
| FunctionsService |
Functions implement User-Defined Functions (UDFs) in Unity Catalog.
|
| GcpAttributes |
|
| 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.
|
| GcpKeyInfo |
|
| GcpManagedNetworkConfig |
The network settings for the workspace.
|
| GcpNetworkInfo |
The Google Cloud specific information for this network (for example, the VPC ID, subnet ID, and
secondary IP ranges).
|
| GcpVpcEndpointInfo |
The Google Cloud specific information for this Private Service Connect endpoint.
|
| Generated |
Annotation to indicate that a class or method is generated from OpenAPI specification.
|
| GetAccountGroupRequest |
Get group details
|
| GetAccountIpAccessListRequest |
Get IP access list
|
| GetAccountMetastoreAssignmentRequest |
Gets the metastore assignment for a workspace
|
| GetAccountMetastoreRequest |
Get a metastore
|
| GetAccountServicePrincipalRequest |
Get service principal details
|
| GetAccountStorageCredentialRequest |
Gets the named storage credential
|
| GetAccountUserRequest |
Get user details
|
| GetAclRequest |
Get secret ACL details
|
| GetActivationUrlInfoRequest |
Get a share activation URL
|
| GetAlertRequest |
Get an alert
|
| GetAssignableRolesForResourceRequest |
Get assignable roles for a resource
|
| GetAssignableRolesForResourceResponse |
|
| GetBudgetRequest |
Get budget and its status
|
| GetByNameRequest |
Get metadata
|
| GetCatalogRequest |
Get a catalog
|
| GetCleanRoomRequest |
Get a clean room
|
| GetClusterPolicyRequest |
Get entity
|
| GetClusterRequest |
Get cluster info
|
| GetConnectionRequest |
Get a connection
|
| GetCredentialRequest |
Get credential configuration
|
| GetCredentialsResponse |
|
| GetCustomAppIntegrationOutput |
|
| GetCustomAppIntegrationRequest |
Get OAuth Custom App Integration
|
| GetCustomAppIntegrationsOutput |
|
| GetDashboardRequest |
Retrieve a definition
|
| GetDbsqlPermissionRequest |
Get object ACL
|
| GetEffectiveRequest |
Get effective permissions
|
| GetEncryptionKeyRequest |
Get encryption key configuration
|
| GetEvents |
|
| GetEventsOrder |
The order to list events in; either "ASC" or "DESC".
|
| GetEventsResponse |
|
| GetExperimentByNameResponse |
|
| GetExperimentRequest |
Get an experiment
|
| GetExternalLocationRequest |
Get an external location
|
| GetFunctionRequest |
Get a function
|
| GetGitCredentialRequest |
Get a credential entry
|
| GetGlobalInitScriptRequest |
Get an init script
|
| GetGrantRequest |
Get permissions
|
| GetGroupRequest |
Get group details
|
| GetHistoryRequest |
Get history of a given metric within a run
|
| GetInstancePool |
|
| GetInstancePoolRequest |
Get instance pool information
|
| GetIpAccessListRequest |
Get access list
|
| GetIpAccessListResponse |
|
| GetIpAccessListsResponse |
|
| GetJobRequest |
Get a single job
|
| GetLatestVersionsRequest |
|
| GetLatestVersionsResponse |
|
| GetLogDeliveryRequest |
Get log delivery configuration
|
| GetMetastoreRequest |
Get a metastore
|
| GetMetastoreSummaryResponse |
|
| GetMetastoreSummaryResponseDeltaSharingScope |
The scope of Delta Sharing enabled for the metastore.
|
| GetMetricHistoryResponse |
|
| GetModelRequest |
Get model
|
| GetModelResponse |
|
| GetModelVersionDownloadUriRequest |
Get a model version URI
|
| GetModelVersionDownloadUriResponse |
|
| GetModelVersionRequest |
Get a model version
|
| GetModelVersionResponse |
|
| GetNetworkRequest |
Get a network configuration
|
| GetPermissionLevelsRequest |
Get permission levels
|
| GetPermissionLevelsResponse |
|
| GetPermissionRequest |
Get object permissions
|
| GetPipelineRequest |
Get a pipeline
|
| GetPipelineResponse |
|
| GetPipelineResponseHealth |
The health of a pipeline.
|
| GetPolicyFamilyRequest |
Get policy family information
|
| GetPrivateAccesRequest |
Get a private access settings object
|
| GetProviderRequest |
Get a provider
|
| GetPublishedAppIntegrationOutput |
|
| GetPublishedAppIntegrationRequest |
Get OAuth Published App Integration
|
| GetPublishedAppIntegrationsOutput |
|
| GetQueryRequest |
Get a query definition.
|
| GetRecipientRequest |
Get a share recipient
|
| GetRecipientSharePermissionsResponse |
|
| GetRepoRequest |
Get a repo
|
| GetResponse |
|
| GetRuleSetRequest |
Get a rule set
|
| GetRunOutputRequest |
Get the output for a single run
|
| GetRunRequest |
Get a single job run
|
| GetRunRequest |
Get a run
|
| GetRunResponse |
|
| GetSchemaRequest |
Get a schema
|
| GetServicePrincipalRequest |
Get service principal details
|
| GetServingEndpointRequest |
Get a single serving endpoint
|
| GetShareRequest |
Get a share
|
| GetSparkVersionsResponse |
|
| GetStatementRequest |
Get status, manifest, and result first chunk
|
| GetStatementResponse |
|
| GetStatementResultChunkNRequest |
Get result chunk by index
|
| GetStatusRequest |
Get the information of a file or directory
|
| GetStatusRequest |
Check configuration status
|
| GetStatusRequest |
Get status
|
| GetStorageCredentialRequest |
Get a credential
|
| GetStorageRequest |
Get storage configuration
|
| GetTableRequest |
Get a table
|
| GetTokenManagementRequest |
Get token info
|
| GetUpdateRequest |
Get a pipeline update
|
| GetUpdateResponse |
|
| GetUserRequest |
Get user details
|
| GetVpcEndpointRequest |
Get a VPC endpoint configuration
|
| GetWarehouseRequest |
Get warehouse info
|
| GetWarehouseResponse |
|
| GetWarehouseResponseWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| GetWorkspaceAssignmentRequest |
List workspace permissions
|
| GetWorkspaceBindingRequest |
Get catalog workspace bindings
|
| GetWorkspaceRequest |
Get a workspace
|
| GetWorkspaceWarehouseConfigResponse |
|
| GetWorkspaceWarehouseConfigResponseSecurityPolicy |
Security policy for warehouses
|
| GitCredentialsAPI |
Registers personal access token for Databricks to do operations on behalf of the user.
|
| GitCredentialsService |
Registers personal access token for Databricks to do operations on behalf of the user.
|
| GitProvider |
|
| GitSnapshot |
Read-only state of the remote repository at the time the job was run.
|
| GitSource |
An optional specification for a remote repository containing the notebooks used by this job's
notebook tasks.
|
| GkeConfig |
The configurations for the GKE cluster of a Databricks workspace.
|
| GkeConfigConnectivityType |
Specifies the network connectivity types for the GKE nodes and the GKE master network.
|
| GlobalInitScriptCreateRequest |
|
| GlobalInitScriptDetails |
|
| GlobalInitScriptDetailsWithContent |
|
| GlobalInitScriptsAPI |
The Global Init Scripts API enables Workspace administrators to configure global initialization
scripts for their workspace.
|
| GlobalInitScriptsService |
The Global Init Scripts API enables Workspace administrators to configure global initialization
scripts for their workspace.
|
| GlobalInitScriptUpdateRequest |
|
| GrantRule |
|
| GrantsAPI |
In Unity Catalog, data is secure by default.
|
| GrantsService |
In Unity Catalog, data is secure by default.
|
| Group |
|
| GroupsAPI |
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
| GroupsService |
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
| HeaderFactory |
|
| HttpClient |
|
| HttpUrlSpec |
|
| HttpUrlSpecWithoutSecret |
|
| Import |
|
| ImportFormat |
This specifies the format of the file to be imported.
|
| InitScriptInfo |
|
| InputTag |
|
| InstallLibraries |
|
| InstancePoolAndStats |
|
| InstancePoolAwsAttributes |
|
| InstancePoolAwsAttributesAvailability |
Availability type used for the spot nodes.
|
| InstancePoolAzureAttributes |
|
| InstancePoolAzureAttributesAvailability |
Shows the Availability type used for the spot nodes.
|
| InstancePoolFleetAttributes |
|
| InstancePoolGcpAttributes |
|
| 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.
|
| 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.
|
| InstancePoolState |
Current state of the instance pool.
|
| InstancePoolStats |
|
| InstancePoolStatus |
|
| InstanceProfile |
|
| InstanceProfilesAPI |
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
| InstanceProfilesService |
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
| IpAccessList |
|
| IpAccessListInfo |
|
| IpAccessListsAPI |
IP Access List enables admins to configure IP access lists.
|
| IpAccessListsService |
IP Access List enables admins to configure IP access lists.
|
| IsolationMode |
Whether the current securable is accessible from all workspaces or a specific set of workspaces.
|
| Job |
|
| JobCluster |
|
| JobCompute |
|
| JobEmailNotifications |
|
| JobNotificationSettings |
|
| JobParameter |
|
| JobParameterDefinition |
|
| JobRunAs |
Write-only setting, available only in Create/Update/Reset and Submit calls.
|
| JobsAPI |
The Jobs API allows you to create, edit, and delete jobs.
|
| JobSettings |
|
| JobsHealthMetric |
Specifies the health metric that is being evaluated for a particular health rule.
|
| JobsHealthOperator |
Specifies the operator used to compare the health metric value with the specified threshold.
|
| JobsHealthRule |
|
| JobsHealthRules |
An optional set of health rules that can be defined for this job.
|
| JobSource |
The source of the job specification in the remote repository when the job is source controlled.
|
| JobSourceDirtyState |
This describes an enum
|
| JobSpec |
|
| JobSpecWithoutSecret |
|
| JobsService |
The Jobs API allows you to create, edit, and delete jobs.
|
| KeyUseCase |
This describes an enum
|
| Language |
|
| Language |
The language of the object.
|
| LibrariesAPI |
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
| LibrariesService |
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
| Library |
|
| LibraryFullStatus |
|
| LibraryFullStatusStatus |
Status of installing the library on the cluster.
|
| ListAccountGroupsRequest |
List group details
|
| ListAccountMetastoreAssignmentsRequest |
Get all workspaces assigned to a metastore
|
| ListAccountServicePrincipalsRequest |
List service principals
|
| ListAccountStorageCredentialsRequest |
Get all storage credentials assigned to a metastore
|
| ListAccountUsersRequest |
List users
|
| ListAclsRequest |
Lists ACLs
|
| ListAclsResponse |
|
| ListAllClusterLibraryStatusesResponse |
|
| ListArtifactsRequest |
Get all artifacts
|
| ListArtifactsResponse |
|
| ListAvailableZonesResponse |
|
| ListCatalogsResponse |
|
| ListCleanRoomsResponse |
|
| ListClusterPoliciesRequest |
Get a cluster policy
|
| ListClustersRequest |
List all clusters
|
| ListClustersResponse |
|
| ListConnectionsResponse |
|
| ListDashboardsRequest |
Get dashboard objects
|
| ListDbfsRequest |
List directory contents or file details
|
| ListEndpointsResponse |
|
| ListExperimentsRequest |
List experiments
|
| ListExperimentsResponse |
|
| ListExternalLocationsResponse |
|
| ListFunctionsRequest |
List functions
|
| ListFunctionsResponse |
|
| ListGlobalInitScriptsResponse |
|
| ListGroupsRequest |
List group details
|
| ListGroupsResponse |
|
| ListInstancePools |
|
| ListInstanceProfilesResponse |
|
| ListJobsRequest |
List jobs
|
| ListJobsResponse |
|
| ListLogDeliveryRequest |
Get all log delivery configurations
|
| ListMetastoresResponse |
|
| ListModelsRequest |
List models
|
| ListModelsResponse |
|
| ListNodeTypesResponse |
|
| ListOrder |
|
| ListPipelineEventsRequest |
List pipeline events
|
| ListPipelineEventsResponse |
|
| ListPipelinesRequest |
List pipelines
|
| ListPipelinesResponse |
|
| ListPoliciesResponse |
|
| ListPolicyFamiliesRequest |
List policy families
|
| ListPolicyFamiliesResponse |
|
| ListProviderSharesResponse |
|
| ListProvidersRequest |
List providers
|
| ListProvidersResponse |
|
| ListQueriesRequest |
Get a list of queries
|
| ListQueriesResponse |
|
| ListQueryHistoryRequest |
List Queries
|
| ListRecipientsRequest |
List share recipients
|
| ListRecipientsResponse |
|
| ListRegistryWebhooks |
|
| ListReposRequest |
Get repos
|
| ListReposResponse |
|
| ListResponse |
|
| ListResponse |
|
| ListRunsRequest |
List job runs
|
| ListRunsResponse |
|
| ListRunsRunType |
This describes an enum
|
| ListSchemasRequest |
List schemas
|
| ListSchemasResponse |
|
| ListScopesResponse |
|
| ListSecretsRequest |
List secret keys
|
| ListSecretsResponse |
|
| ListServicePrincipalResponse |
|
| ListServicePrincipalSecretsRequest |
List service principal secrets
|
| ListServicePrincipalSecretsResponse |
|
| ListServicePrincipalsRequest |
List service principals
|
| ListSharesRequest |
List shares by Provider
|
| ListSharesResponse |
|
| ListSortColumn |
|
| ListSortOrder |
|
| ListSortOrder |
|
| ListStatusResponse |
|
| ListStorageCredentialsResponse |
|
| ListSummariesRequest |
List table summaries
|
| ListSystemSchemasRequest |
List system schemas
|
| ListSystemSchemasResponse |
|
| ListTablesRequest |
List tables
|
| ListTablesResponse |
|
| ListTableSummariesResponse |
|
| ListTokenManagementRequest |
List all tokens
|
| ListTokensResponse |
|
| ListTransitionRequestsRequest |
List transition requests
|
| ListTransitionRequestsResponse |
|
| ListType |
This describes an enum
|
| ListUpdatesRequest |
List pipeline updates
|
| ListUpdatesResponse |
|
| ListUsersRequest |
List users
|
| ListUsersResponse |
|
| ListVolumesRequest |
List Volumes
|
| ListVolumesResponseContent |
|
| ListWarehousesRequest |
List warehouses
|
| ListWarehousesResponse |
|
| ListWebhooksRequest |
List registry webhooks
|
| ListWorkspaceAssignmentRequest |
Get permission assignments
|
| ListWorkspaceRequest |
List contents
|
| LogAnalyticsInfo |
|
| LogBatch |
|
| LogDeliveryAPI |
These APIs manage log delivery configurations for this account.
|
| LogDeliveryConfigStatus |
Status of log delivery configuration.
|
| LogDeliveryConfiguration |
|
| LogDeliveryService |
These APIs manage log delivery configurations for this account.
|
| LogDeliveryStatus |
Databricks log delivery status.
|
| LogInputs |
|
| LogMetric |
|
| LogModel |
|
| LogParam |
|
| LogsRequest |
Retrieve the most recent log lines associated with a given serving endpoint's served model
|
| LogSyncStatus |
|
| LogType |
Log delivery type.
|
| MaturityLevel |
Maturity level for EventDetails.
|
| MavenLibrary |
|
| MetastoreAssignment |
|
| MetastoreInfo |
|
| MetastoreInfoDeltaSharingScope |
The scope of Delta Sharing enabled for the metastore.
|
| MetastoresAPI |
A metastore is the top-level container of objects in Unity Catalog.
|
| MetastoresService |
A metastore is the top-level container of objects in Unity Catalog.
|
| Metric |
|
| Mkdirs |
|
| MkDirs |
|
| Model |
|
| ModelDatabricks |
|
| 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.
|
| 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.
|
| ModelTag |
|
| ModelVersion |
|
| ModelVersionDatabricks |
|
| ModelVersionStatus |
Current status of `model_version`
|
| ModelVersionTag |
|
| Move |
|
| Name |
|
| NamedTableConstraint |
|
| Network |
|
| NetworkHealth |
|
| NetworksAPI |
These APIs manage network configurations for customer-managed VPCs (optional).
|
| NetworksService |
These APIs manage network configurations for customer-managed VPCs (optional).
|
| NetworkVpcEndpoints |
If specified, contains the VPC endpoints used to allow cluster communication from this VPC over
[AWS PrivateLink].
|
| NetworkWarning |
|
| NodeInstanceType |
|
| NodeType |
|
| NodeTypeSelector |
|
| NotebookLibrary |
|
| NotebookOutput |
|
| NotebookTask |
|
| OAuthClient |
Enables 3-legged OAuth2 flow with PKCE
|
| OAuthClient.Builder |
|
| OAuthEnrollmentAPI |
These APIs enable administrators to enroll OAuth for their accounts, which is required for
adding/using any OAuth published/custom application integration.
|
| OAuthEnrollmentService |
These APIs enable administrators to enroll OAuth for their accounts, which is required for
adding/using any OAuth published/custom application integration.
|
| OAuthEnrollmentStatus |
|
| OAuthM2MServicePrincipalCredentialsProvider |
Adds refreshed Databricks machine-to-machine OAuth Bearer token to every request, if
/oidc/.well-known/oauth-authorization-server is available on the given host.
|
| OAuthResponse |
The response from an OAuth token request.
|
| ObjectInfo |
|
| ObjectPermissions |
|
| ObjectType |
A singular noun object type.
|
| ObjectType |
The type of the object in workspace.
|
| ObjectTypePlural |
Always a plural of the object type.
|
| OdbcParams |
|
| OpenIDConnectEndpoints |
Data class modelling the set of OpenID Connect endpoints, as defined in the
OIDC spec. |
| Origin |
|
| OSUtils |
OSUtils is an interface that provides utility methods for determining the current operating
system and returning executable command based on the operating system.
|
| OutputFormat |
The file type of log delivery.
|
| OwnableObjectType |
The singular form of the type of object which can be owned.
|
| Paginator<RQ,RS,T> |
Consistent pagination support for all APIs
|
| Param |
|
| Parameter |
|
| ParameterType |
Parameters can have several different types.
|
| PartialUpdate |
|
| Partition |
|
| PartitionValue |
|
| PartitionValueOp |
The operator to apply for the value.
|
| Patch |
|
| PatchOp |
Type of patch operation.
|
| PatchSchema |
|
| PatCredentialsProvider |
|
| PauseStatus |
|
| PendingInstanceError |
|
| PermanentDeleteCluster |
|
| Permission |
|
| PermissionAssignment |
|
| PermissionAssignments |
|
| PermissionLevel |
Permission level
|
| PermissionLevel |
Permission level of the requesting user on the object.
|
| PermissionLevel |
This describes an enum
|
| PermissionOutput |
|
| PermissionsAPI |
Permissions API are used to create read, write, edit, update and manage access for various users
on different objects and endpoints.
|
| PermissionsChange |
|
| PermissionsDescription |
|
| PermissionsList |
|
| PermissionsRequest |
|
| PermissionsService |
Permissions API are used to create read, write, edit, update and manage access for various users
on different objects and endpoints.
|
| PersonalComputeMessage |
|
| PersonalComputeMessageEnum |
ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing
all users to create single-machine compute resources.
|
| PersonalComputeSetting |
|
| PinCluster |
|
| PipelineCluster |
|
| PipelineEvent |
|
| PipelineLibrary |
|
| PipelineParams |
|
| PipelinesAPI |
The Delta Live Tables API allows you to create, edit, delete, start, and view details about
pipelines.
|
| PipelineSpec |
|
| PipelinesService |
The Delta Live Tables API allows you to create, edit, delete, start, and view details about
pipelines.
|
| PipelineState |
The pipeline state.
|
| PipelineStateInfo |
|
| PipelineTask |
|
| PipelineTrigger |
|
| PlansState |
Whether plans exist for the execution, or the reason why they are missing
|
| Policy |
|
| PolicyFamiliesAPI |
View available policy families.
|
| PolicyFamiliesService |
View available policy families.
|
| PolicyFamily |
|
| PricingTier |
The pricing tier of the workspace.
|
| PrimaryKeyConstraint |
|
| PrincipalOutput |
|
| PrivateAccessAPI |
These APIs manage private access settings for this account.
|
| 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.
|
| PrivateAccessService |
These APIs manage private access settings for this account.
|
| PrivateAccessSettings |
|
| Privilege |
|
| Privilege |
|
| PrivilegeAssignment |
|
| PrivilegeAssignment |
|
| ProviderInfo |
|
| ProvidersAPI |
Databricks Providers REST API
|
| ProviderShare |
|
| ProvidersService |
Databricks Providers REST API
|
| PublicTokenInfo |
|
| 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.
|
| 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.
|
| Put |
|
| PutAcl |
|
| PutSecret |
|
| PythonPyPiLibrary |
|
| PythonWheelTask |
|
| QueriesAPI |
These endpoints are used for CRUD operations on query definitions.
|
| QueriesService |
These endpoints are used for CRUD operations on query definitions.
|
| Query |
|
| QueryEditContent |
|
| QueryEndpointResponse |
|
| QueryFilter |
A filter to limit query history results.
|
| QueryHistoryAPI |
Access the history of queries through SQL warehouses.
|
| QueryHistoryService |
Access the history of queries through SQL warehouses.
|
| QueryInfo |
|
| QueryList |
|
| QueryMetrics |
Metrics about query execution.
|
| QueryOptions |
|
| QueryParam |
|
| QueryPostContent |
|
| QueryRequest |
Query a serving endpoint with provided model input.
|
| QueryStatementType |
Type of statement for this query
|
| QueryStatus |
This describes an enum
|
| RCranLibrary |
|
| ReadDbfsRequest |
Get the contents of a file
|
| ReadPersonalComputeSettingRequest |
Get Personal Compute setting
|
| ReadResponse |
|
| ReadVolumeRequest |
Get a Volume
|
| RealTimer |
|
| RecipientActivationAPI |
Databricks Recipient Activation REST API
|
| RecipientActivationService |
Databricks Recipient Activation REST API
|
| RecipientInfo |
|
| RecipientProfile |
|
| RecipientsAPI |
Databricks Recipients REST API
|
| RecipientsService |
Databricks Recipients REST API
|
| RecipientTokenInfo |
|
| RefreshableTokenSource |
An OAuth TokenSource which can be refreshed.
|
| RegistryWebhook |
|
| RegistryWebhookEvent |
|
| RegistryWebhookStatus |
This describes an enum
|
| RejectTransitionRequest |
|
| RejectTransitionRequestResponse |
|
| RemoveInstanceProfile |
|
| RenameModelRequest |
|
| RenameModelResponse |
|
| RepairHistoryItem |
|
| RepairHistoryItemType |
The repair history item type.
|
| RepairRun |
|
| RepairRunResponse |
|
| RepeatedEndpointConfPairs |
|
| ReplaceIpAccessList |
|
| RepoInfo |
|
| ReposAPI |
The Repos API allows users to manage their git repos.
|
| ReposService |
The Repos API allows users to manage their git repos.
|
| Request |
|
| ResetJob |
|
| ResetRequest |
Reset a pipeline
|
| ResizeCluster |
|
| ResolvedConditionTaskValues |
|
| ResolvedDbtTaskValues |
|
| ResolvedNotebookTaskValues |
|
| ResolvedParamPairValues |
|
| ResolvedPythonWheelTaskValues |
|
| ResolvedRunJobTaskValues |
|
| ResolvedStringParamsValues |
|
| ResolvedValues |
|
| ResourceMeta |
|
| Response |
|
| RestartCluster |
|
| RestoreDashboardRequest |
Restore a dashboard
|
| RestoreExperiment |
|
| RestoreQueryRequest |
Restore a query
|
| RestoreRun |
|
| 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.
|
| ResultManifest |
The result manifest provides schema and metadata for the result set.
|
| Results |
|
| ResultSchema |
Schema is an ordered list of column descriptions.
|
| ResultType |
|
| RetrieveTokenRequest |
Get an access token
|
| RetrieveTokenResponse |
|
| RevokeTokenRequest |
|
| RootBucketInfo |
Root S3 bucket information.
|
| RotateRecipientToken |
|
| Route |
|
| RuleSetResponse |
|
| RuleSetUpdateRequest |
|
| Run |
|
| Run |
|
| RunConditionTask |
|
| RunConditionTaskOp |
The condtion task operator.
|
| RunData |
|
| RunIf |
This describes an enum
|
| RunInfo |
|
| RunInfoStatus |
Current status of the run.
|
| RunInputs |
|
| RunJobOutput |
|
| RunJobTask |
|
| RunLifeCycleState |
This describes an enum
|
| RunNow |
|
| RunNowResponse |
|
| RunOutput |
|
| RunParameters |
|
| RunResultState |
This describes an enum
|
| RunState |
The current state of the run.
|
| RunTag |
|
| RunTask |
|
| RuntimeEngine |
Decides which runtime engine to be use, e.g.
|
| RunType |
This describes an enum
|
| S3StorageInfo |
|
| SchemaInfo |
|
| SchemasAPI |
A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
|
| SchemasService |
A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
|
| ScopeBackendType |
|
| SearchExperiments |
|
| SearchExperimentsResponse |
|
| SearchExperimentsViewType |
Qualifier for type of experiments to be returned.
|
| SearchModelsRequest |
Search models
|
| SearchModelsResponse |
|
| SearchModelVersionsRequest |
Searches model versions
|
| SearchModelVersionsResponse |
|
| SearchRuns |
|
| SearchRunsResponse |
|
| SearchRunsRunViewType |
Whether to display only active, only deleted, or all runs.
|
| SecretInfo |
|
| SecretMetadata |
|
| SecretsAPI |
The Secrets API allows you to manage secrets, secret scopes, and access permissions.
|
| SecretScope |
|
| SecretsService |
The Secrets API allows you to manage secrets, secret scopes, and access permissions.
|
| SecurablePropertiesKvPairs |
An object with __properties__ containing map of key-value properties attached to the securable.
|
| SecurableType |
The type of Unity Catalog securable
|
| SemVer |
|
| Sequencing |
|
| SerializedException |
|
| ServedModelInput |
|
| ServedModelOutput |
|
| ServedModelSpec |
|
| ServedModelState |
|
| ServedModelStateDeployment |
The state of the served model deployment.
|
| ServerLogsResponse |
|
| ServiceError |
|
| ServiceErrorCode |
|
| ServicePrincipal |
|
| ServicePrincipalsAPI |
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
| ServicePrincipalSecretsAPI |
These APIs enable administrators to manage service principal secrets.
|
| ServicePrincipalSecretsService |
These APIs enable administrators to manage service principal secrets.
|
| ServicePrincipalsService |
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
| ServingEndpoint |
|
| ServingEndpointDetailed |
|
| ServingEndpointDetailedPermissionLevel |
The permission level of the principal making the request.
|
| ServingEndpointsAPI |
The Serving Endpoints API allows you to create, update, and delete model serving endpoints.
|
| ServingEndpointsService |
The Serving Endpoints API allows you to create, update, and delete model serving endpoints.
|
| SessionCredentials |
An implementation of RefreshableTokenSource implementing the refresh_token OAuth grant type.
|
| SetExperimentTag |
|
| SetModelTagRequest |
|
| SetModelVersionTagRequest |
|
| SetRequest |
Set object ACL
|
| SetResponse |
|
| SetTag |
|
| SetWorkspaceWarehouseConfigRequest |
|
| SetWorkspaceWarehouseConfigRequestSecurityPolicy |
Security policy for warehouses
|
| SharedDataObject |
|
| SharedDataObjectHistoryDataSharingStatus |
Whether to enable or disable sharing of data history.
|
| SharedDataObjectStatus |
One of: **ACTIVE**, **PERMISSION_DENIED**.
|
| SharedDataObjectUpdate |
|
| SharedDataObjectUpdateAction |
One of: **ADD**, **REMOVE**, **UPDATE**.
|
| ShareInfo |
|
| SharePermissionsRequest |
Get recipient share permissions
|
| SharesAPI |
Databricks Shares REST API
|
| SharesService |
Databricks Shares REST API
|
| ShareToPrivilegeAssignment |
|
| Source |
|
| SparkJarTask |
|
| SparkNode |
|
| SparkNodeAwsAttributes |
|
| SparkPythonTask |
|
| SparkSubmitTask |
|
| SparkVersion |
|
| SparkVersionSelector |
|
| SparseCheckout |
|
| SparseCheckoutUpdate |
|
| SpotInstancePolicy |
Configurations whether the warehouse should use spot instances.
|
| SqlAlertOutput |
|
| SqlAlertState |
The state of the SQL alert.
|
| SqlDashboardOutput |
|
| SqlDashboardWidgetOutput |
|
| SqlDashboardWidgetOutputStatus |
The execution status of the SQL widget.
|
| SqlOutput |
|
| SqlOutputError |
|
| SqlQueryOutput |
|
| SqlStatementOutput |
|
| SqlTask |
|
| SqlTaskAlert |
|
| SqlTaskDashboard |
|
| SqlTaskFile |
|
| SqlTaskQuery |
|
| SqlTaskSubscription |
|
| StackFrame |
|
| Stage |
This describes an enum
|
| StartCluster |
|
| StartRequest |
Start a warehouse
|
| StartUpdate |
|
| StartUpdateCause |
|
| StartUpdateResponse |
|
| State |
Current state of the cluster.
|
| State |
State of the warehouse
|
| StatementExecutionAPI |
The SQL Statement Execution API manages the execution of arbitrary SQL statements and the
fetching of result data.
|
| StatementExecutionService |
The SQL Statement Execution API manages the execution of arbitrary SQL statements and the
fetching of result data.
|
| StatementState |
Statement execution state: - `PENDING`: waiting for warehouse - `RUNNING`: running - `SUCCEEDED`:
execution was successful, result data available for fetch - `FAILED`: execution failed; reason
for failure described in accomanying error message - `CANCELED`: user canceled; can come from
explicit cancel call, or timeout with `on_wait_timeout=CANCEL` - `CLOSED`: execution successful,
and statement closed; result no longer available for fetch
|
| StatementStatus |
Status response includes execution state and if relevant, error information.
|
| Status |
This describes an enum
|
| Status |
Health status of the warehouse.
|
| StopRequest |
Stop a pipeline
|
| StopRequest |
Stop a warehouse
|
| StorageAPI |
These APIs manage storage configurations for this workspace.
|
| StorageConfiguration |
|
| StorageCredentialInfo |
|
| StorageCredentialsAPI |
A storage credential represents an authentication and authorization mechanism for accessing data
stored on your cloud tenant.
|
| StorageCredentialsService |
A storage credential represents an authentication and authorization mechanism for accessing data
stored on your cloud tenant.
|
| StorageService |
These APIs manage storage configurations for this workspace.
|
| StsRole |
|
| SubmitRun |
|
| SubmitRunResponse |
|
| SubmitTask |
|
| Success |
|
| SuccessMessage |
|
| SystemSchemaInfo |
|
| SystemSchemaInfoState |
The current state of enablement for the system schema.
|
| SystemSchemasAPI |
A system schema is a schema that lives within the system catalog.
|
| SystemSchemasService |
A system schema is a schema that lives within the system catalog.
|
| TableConstraint |
A table constraint, as defined by *one* of the following fields being set:
__primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.
|
| TableConstraintList |
|
| TableConstraintsAPI |
Primary key and foreign key constraints encode relationships between fields in tables.
|
| TableConstraintsService |
Primary key and foreign key constraints encode relationships between fields in tables.
|
| TableDependency |
A table that is dependent on a SQL object.
|
| TableInfo |
|
| TableRowFilter |
|
| TablesAPI |
A table resides in the third layer of Unity Catalog’s three-level namespace.
|
| TablesService |
A table resides in the third layer of Unity Catalog’s three-level namespace.
|
| TableSummary |
|
| TableType |
|
| Task |
|
| TaskDependency |
|
| TaskEmailNotifications |
|
| TaskNotificationSettings |
|
| TerminationReason |
|
| TerminationReason |
|
| TerminationReasonCode |
status code indicating why the cluster was terminated
|
| TerminationReasonCode |
status code indicating why the cluster was terminated
|
| TerminationReasonType |
type of the termination
|
| TerminationReasonType |
type of the termination
|
| TestRegistryWebhook |
Test webhook response object.
|
| TestRegistryWebhookRequest |
|
| TestRegistryWebhookResponse |
|
| TimeoutAction |
When in synchronous mode with `wait_timeout > 0s` it determines the action taken when the timeout
is reached:
|
| Timer |
|
| TimeRange |
|
| Token |
|
| TokenAccessPolicy |
|
| TokenInfo |
|
| TokenManagementAPI |
Enables administrators to get all tokens and delete tokens for other users.
|
| TokenManagementService |
Enables administrators to get all tokens and delete tokens for other users.
|
| TokensAPI |
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and
access Databricks REST APIs.
|
| TokenSource |
A resource which can produce an OAuth token.
|
| TokensService |
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and
access Databricks REST APIs.
|
| ToStringer |
|
| TrafficConfig |
|
| TransferOwnershipObjectId |
|
| TransferOwnershipRequest |
Transfer object ownership
|
| TransitionModelVersionStageDatabricks |
|
| TransitionRequest |
Transition request details.
|
| TransitionStageResponse |
|
| TriggerEvaluation |
|
| TriggerHistory |
|
| TriggerInfo |
|
| TriggerSettings |
|
| TriggerType |
This describes an enum
|
| UnassignRequest |
Delete an assignment
|
| UninstallLibraries |
|
| UnpinCluster |
|
| UpdateAutoMaintenance |
|
| UpdateAutoMaintenanceResponse |
|
| UpdateCatalog |
|
| UpdateCleanRoom |
|
| UpdateComment |
|
| UpdateCommentResponse |
|
| UpdateConnection |
|
| UpdateCredentials |
|
| UpdateCustomAppIntegration |
|
| UpdateExperiment |
|
| UpdateExternalLocation |
|
| UpdateFunction |
|
| UpdateInfo |
|
| UpdateInfoCause |
What triggered this update.
|
| UpdateInfoState |
The update state.
|
| UpdateIpAccessList |
|
| UpdateJob |
|
| UpdateLogDeliveryConfigurationStatusRequest |
|
| UpdateMetastore |
|
| UpdateMetastoreAssignment |
|
| UpdateMetastoreDeltaSharingScope |
The scope of Delta Sharing enabled for the metastore.
|
| UpdateModelRequest |
|
| UpdateModelVersionRequest |
|
| UpdatePermissions |
|
| UpdatePersonalComputeSettingRequest |
Update Personal Compute setting
|
| UpdatePredictiveOptimization |
|
| UpdatePredictiveOptimizationResponse |
|
| UpdateProvider |
|
| UpdatePublishedAppIntegration |
|
| UpdateRecipient |
|
| UpdateRegistryWebhook |
|
| UpdateRepo |
|
| UpdateRuleSetRequest |
|
| UpdateRun |
|
| UpdateRunResponse |
|
| UpdateRunStatus |
Updated status of the run.
|
| UpdateSchema |
|
| UpdateShare |
|
| UpdateSharePermissions |
|
| UpdateStateInfo |
|
| UpdateStateInfoState |
|
| UpdateStorageCredential |
|
| UpdateTableRequest |
Update a table owner.
|
| UpdateVolumeRequestContent |
|
| UpdateWorkspaceAssignments |
|
| UpdateWorkspaceBindings |
|
| UpdateWorkspaceRequest |
|
| UpsertPrivateAccessSettingsRequest |
|
| User |
|
| User |
|
| UserAgent |
|
| UsersAPI |
User identities recognized by Databricks and represented by email addresses.
|
| UsersService |
User identities recognized by Databricks and represented by email addresses.
|
| ValidateStorageCredential |
|
| ValidateStorageCredentialResponse |
|
| ValidationResult |
|
| ValidationResultOperation |
The operation tested.
|
| ValidationResultResult |
The results of the tested operation.
|
| ViewItem |
|
| ViewsToExport |
This describes an enum
|
| ViewType |
This describes an enum
|
| Visualization |
The visualization description API changes frequently and is unsupported.
|
| VolumeInfo |
|
| VolumesAPI |
Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and
processing files.
|
| VolumesService |
Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and
processing files.
|
| VolumeType |
|
| VpcEndpoint |
|
| VpcEndpointsAPI |
These APIs manage VPC endpoint configurations for this account.
|
| VpcEndpointsService |
These APIs manage VPC endpoint configurations for this account.
|
| VpcStatus |
This describes an enum
|
| Wait<T,R> |
|
| WaitStarter<T> |
|
| WarehousesAPI |
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| WarehousesService |
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
| WarehouseTypePair |
|
| WarehouseTypePairWarehouseType |
Warehouse type: `PRO` or `CLASSIC`.
|
| WarningType |
The AWS resource associated with this warning: a subnet or a security group.
|
| Webhook |
|
| WebhookNotifications |
|
| WebhookNotificationsOnDurationWarningThresholdExceededItem |
|
| Widget |
|
| WidgetOptions |
|
| WorkloadType |
|
| Workspace |
|
| WorkspaceAPI |
The Workspace API allows you to list, import, export, and delete notebooks and folders.
|
| WorkspaceAssignmentAPI |
The Workspace Permission Assignment API allows you to manage workspace permissions for principals
in your account.
|
| WorkspaceAssignmentService |
The Workspace Permission Assignment API allows you to manage workspace permissions for principals
in your account.
|
| WorkspaceBindingsAPI |
A catalog in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
| WorkspaceBindingsService |
A catalog in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
| WorkspaceClient |
Entry point for accessing Databricks workspace-level APIs
|
| WorkspaceConfAPI |
This API allows updating known workspace settings for advanced users.
|
| WorkspaceConfService |
This API allows updating known workspace settings for advanced users.
|
| WorkspacePermission |
|
| WorkspacePermissions |
|
| WorkspacesAPI |
These APIs manage workspaces for this account.
|
| WorkspaceService |
The Workspace API allows you to list, import, export, and delete notebooks and folders.
|
| WorkspacesService |
These APIs manage workspaces for this account.
|
| WorkspaceStatus |
The status of the workspace.
|
| WorkspaceStorageInfo |
|
| WrappedBudget |
|
| WrappedBudgetWithStatus |
|
| WrappedCreateLogDeliveryConfiguration |
|
| WrappedLogDeliveryConfiguration |
|
| WrappedLogDeliveryConfigurations |
|