| Modifier and Type | Class and Description |
|---|---|
class |
AccountClient
Entry point for accessing Databricks account-level APIs
|
class |
WorkspaceClient
Entry point for accessing Databricks workspace-level APIs
|
| Modifier and Type | Class and Description |
|---|---|
class |
Aborted
the operation was aborted, typically due to a concurrency issue such as a sequencer check failure
|
class |
AlreadyExists
operation was rejected due a conflict with an existing resource
|
class |
BadRequest
the request is invalid
|
class |
Cancelled
the operation was explicitly canceled by the caller
|
class |
DataLoss
unrecoverable data loss or corruption
|
class |
DeadlineExceeded
the deadline expired before the operation could complete
|
class |
InternalError
some invariants expected by the underlying system have been broken
|
class |
InvalidParameterValue
supplied value for a parameter was invalid
|
class |
InvalidState
unexpected state
|
class |
NotFound
the operation was performed on a resource that does not exist
|
class |
NotImplemented
the operation is not implemented or is not supported/enabled in this service
|
class |
PermissionDenied
the caller does not have permission to execute the specified operation
|
class |
RequestLimitExceeded
cluster request was rejected because it would exceed a resource limit
|
class |
ResourceAlreadyExists
operation was rejected due a conflict with an existing resource
|
class |
ResourceConflict
maps to all HTTP 409 (Conflict) responses
|
class |
ResourceDoesNotExist
operation was performed on a resource that does not exist
|
class |
ResourceExhausted
operation is rejected due to per-user rate limiting
|
class |
TemporarilyUnavailable
the service is currently unavailable
|
class |
TooManyRequests
maps to HTTP code: 429 Too Many Requests
|
class |
Unauthenticated
the request does not have valid authentication (AuthN) credentials for the operation
|
class |
Unknown
this error is used as a fallback if the platform-side mapping is missing some reason
|
| Modifier and Type | Class and Description |
|---|---|
class |
AgentBricksAPI
The Custom LLMs service manages state and powers the UI for the Custom LLM product.
|
interface |
AgentBricksService
The Custom LLMs service manages state and powers the UI for the Custom LLM product.
|
class |
CancelCustomLlmOptimizationRunRequest |
class |
CreateCustomLlmRequest |
class |
CustomLlm |
class |
Dataset |
class |
DeleteCustomLlmRequest |
class |
GetCustomLlmRequest |
class |
StartCustomLlmOptimizationRunRequest |
class |
State
States of Custom LLM optimization lifecycle.
|
class |
Table |
class |
UpdateCustomLlmRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
ActionConfiguration |
class |
ActionConfigurationType |
class |
AlertConfiguration |
class |
AlertConfigurationQuantityType |
class |
AlertConfigurationTimePeriod |
class |
AlertConfigurationTriggerType |
class |
BillableUsageAPI
This API allows you to download billable usage logs for the specified account and date range.
|
interface |
BillableUsageService
This API allows you to download billable usage logs for the specified account and date range.
|
class |
BudgetConfiguration |
class |
BudgetConfigurationFilter |
class |
BudgetConfigurationFilterClause |
class |
BudgetConfigurationFilterOperator |
class |
BudgetConfigurationFilterTagClause |
class |
BudgetConfigurationFilterWorkspaceIdClause |
class |
BudgetPolicy
Contains the BudgetPolicy details.
|
class |
BudgetPolicyAPI
A service serves REST API about Budget policies
|
interface |
BudgetPolicyService
A service serves REST API about Budget policies
This is the high-level interface, that contains generated methods.
|
class |
BudgetsAPI
These APIs manage budget configurations for this account.
|
interface |
BudgetsService
These APIs manage budget configurations for this account.
|
class |
CreateBillingUsageDashboardRequest |
class |
CreateBillingUsageDashboardResponse |
class |
CreateBudgetConfigurationBudget |
class |
CreateBudgetConfigurationBudgetActionConfigurations |
class |
CreateBudgetConfigurationBudgetAlertConfigurations |
class |
CreateBudgetConfigurationRequest |
class |
CreateBudgetConfigurationResponse |
class |
CreateBudgetPolicyRequest
A request to create a BudgetPolicy.
|
class |
CreateLogDeliveryConfigurationParams
Log Delivery Configuration
|
class |
DeleteBudgetConfigurationRequest |
class |
DeleteBudgetPolicyRequest |
class |
DeliveryStatus
* The status string for log delivery.
|
class |
DownloadRequest |
class |
DownloadResponse |
class |
Filter
Structured representation of a filter to be applied to a list of policies.
|
class |
GetBillingUsageDashboardRequest |
class |
GetBillingUsageDashboardResponse |
class |
GetBudgetConfigurationRequest |
class |
GetBudgetConfigurationResponse |
class |
GetBudgetPolicyRequest |
class |
GetLogDeliveryConfigurationResponse |
class |
GetLogDeliveryRequest |
class |
LimitConfig
The limit configuration of the policy.
|
class |
ListBudgetConfigurationsRequest |
class |
ListBudgetConfigurationsResponse |
class |
ListBudgetPoliciesRequest |
class |
ListBudgetPoliciesResponse
A list of policies.
|
class |
ListLogDeliveryRequest |
class |
LogDeliveryAPI
These APIs manage log delivery configurations for this account.
|
class |
LogDeliveryConfigStatus
* Log Delivery Status
`ENABLED`: All dependencies have executed and succeeded `DISABLED`: At least one dependency
has succeeded
|
class |
LogDeliveryConfiguration
Log Delivery Configuration
|
interface |
LogDeliveryService
These APIs manage log delivery configurations for this account.
|
class |
LogDeliveryStatus |
class |
LogType
Log Delivery Type
|
class |
OutputFormat
Log Delivery Output Format
|
class |
SortSpec |
class |
SortSpecField |
class |
UpdateBudgetConfigurationBudget |
class |
UpdateBudgetConfigurationRequest |
class |
UpdateBudgetConfigurationResponse |
class |
UpdateBudgetPolicyRequest |
class |
UpdateLogDeliveryConfigurationStatusRequest
Update Log Delivery Configuration
|
class |
UsageDashboardMajorVersion |
class |
UsageDashboardsAPI
These APIs manage usage dashboards for this account.
|
interface |
UsageDashboardsService
These APIs manage usage dashboards for this account.
|
class |
UsageDashboardType |
class |
WrappedCreateLogDeliveryConfiguration
Properties of the new log delivery configuration.
|
class |
WrappedLogDeliveryConfiguration |
class |
WrappedLogDeliveryConfigurations |
| Modifier and Type | Class and Description |
|---|---|
class |
BundleAPI
Service for managing bundle deployment metadata.
|
interface |
BundleService
Service for managing bundle deployment metadata.
|
class |
CompleteVersionRequest
A request to complete a Version.
|
class |
CreateDeploymentRequest |
class |
CreateOperationRequest |
class |
CreateVersionRequest |
class |
DeleteDeploymentRequest |
class |
Deployment
A bundle deployment registered with the control plane.
|
class |
DeploymentResourceType
Type of a deployment resource.
|
class |
DeploymentStatus
Status of a deployment.
|
class |
GetDeploymentRequest |
class |
GetOperationRequest |
class |
GetResourceRequest |
class |
GetVersionRequest |
class |
HeartbeatRequest
A request to send a heartbeat for a Version.
|
class |
HeartbeatResponse
Response for Heartbeat.
|
class |
ListDeploymentsRequest |
class |
ListDeploymentsResponse
Response for ListDeployments.
|
class |
ListOperationsRequest |
class |
ListOperationsResponse
Response for ListOperations.
|
class |
ListResourcesRequest |
class |
ListResourcesResponse
Response for ListResources.
|
class |
ListVersionsRequest |
class |
ListVersionsResponse
Response for ListVersions.
|
class |
Operation
An operation on a single resource performed during a version.
|
class |
OperationActionType
Type of action performed on a resource during a deployment.
|
class |
OperationStatus
Status of a resource operation.
|
class |
Resource
A resource managed by a deployment.
|
class |
Version
A single invocation of a deploy or destroy command against a deployment.
|
class |
VersionComplete
Reason why a version was completed.
|
class |
VersionStatus
Status of a version.
|
class |
VersionType
Type of version.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AccessRequestDestinations |
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
Properties of the new metastore.
|
class |
AccountsCreateMetastoreAssignment
The mapping from workspace to metastore.
|
class |
AccountsCreateMetastoreAssignmentResponse
The metastore assignment was successfully created.
|
class |
AccountsCreateMetastoreResponse |
class |
AccountsCreateStorageCredential |
class |
AccountsCreateStorageCredentialInfo |
class |
AccountsDeleteMetastoreAssignmentResponse
The metastore assignment was successfully deleted.
|
class |
AccountsDeleteMetastoreResponse
The metastore was successfully deleted.
|
class |
AccountsDeleteStorageCredentialResponse
The storage credential was successfully deleted.
|
class |
AccountsGetMetastoreResponse
The metastore was successfully returned.
|
class |
AccountsListMetastoresResponse
Metastores were returned successfully.
|
class |
AccountsMetastoreAssignment
The workspace metastore assignment was successfully returned.
|
class |
AccountsStorageCredentialInfo
The storage credential was successfully retrieved.
|
class |
AccountStorageCredentialsAPI
These APIs manage storage credentials for a particular metastore.
|
interface |
AccountStorageCredentialsService
These APIs manage storage credentials for a particular metastore.
|
class |
AccountsUpdateMetastore
Properties of the metastore to change.
|
class |
AccountsUpdateMetastoreAssignment
The metastore assignment to update.
|
class |
AccountsUpdateMetastoreAssignmentResponse
The metastore assignment was successfully updated.
|
class |
AccountsUpdateMetastoreResponse
The metastore update request succeeded.
|
class |
AccountsUpdateStorageCredential
The storage credential to update.
|
class |
AccountsUpdateStorageCredentialResponse
The storage credential was successfully updated.
|
class |
ArtifactAllowlistInfo |
class |
ArtifactAllowlistsAPI
In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist`
in UC so that users can leverage these artifacts on compute configured with shared access mode.
|
interface |
ArtifactAllowlistsService
In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist`
in UC so that users can leverage these artifacts on compute configured with shared access mode.
|
class |
ArtifactMatcher |
class |
ArtifactType
The artifact type
|
class |
AwsCredentials
AWS temporary credentials for API authentication.
|
class |
AwsIamRole
The AWS IAM role configuration
|
class |
AwsIamRoleRequest
The AWS IAM role configuration
|
class |
AwsIamRoleResponse
The AWS IAM role configuration
|
class |
AwsSqsQueue |
class |
AzureActiveDirectoryToken
Azure Active Directory token, essentially the Oauth token for Azure Service Principal or Managed
Identity.
|
class |
AzureEncryptionSettings |
class |
AzureManagedIdentity
The Azure managed identity configuration.
|
class |
AzureManagedIdentityRequest
The Azure managed identity configuration.
|
class |
AzureManagedIdentityResponse
The Azure managed identity configuration.
|
class |
AzureQueueStorage |
class |
AzureServicePrincipal
The Azure service principal configuration.
|
class |
AzureUserDelegationSas
Azure temporary credentials for API authentication.
|
class |
BatchCreateAccessRequestsRequest |
class |
BatchCreateAccessRequestsResponse |
class |
CancelRefreshRequest |
class |
CatalogInfo |
class |
CatalogIsolationMode |
class |
CatalogsAPI
A catalog is the first layer of Unity Catalog’s three-level namespace.
|
interface |
CatalogsService
A catalog is the first layer of Unity Catalog’s three-level namespace.
|
class |
CatalogType
The type of the catalog.
|
class |
CloudflareApiToken
The Cloudflare API token configuration.
|
class |
ColumnInfo |
class |
ColumnMask |
class |
ColumnMaskOptions |
class |
ColumnRelationship |
class |
ColumnTypeName |
class |
ConnectionDependency
A connection that is dependent on a SQL object.
|
class |
ConnectionInfo |
class |
ConnectionsAPI
Connections allow for creating a connection to an external data source.
|
interface |
ConnectionsService
Connections allow for creating a connection to an external data source.
|
class |
ConnectionType
Next Id: 125
|
class |
ContinuousUpdateStatus
Detailed status of an online table.
|
class |
CreateAccessRequest |
class |
CreateAccessRequestResponse |
class |
CreateAccountsMetastore |
class |
CreateAccountsStorageCredential |
class |
CreateCatalog |
class |
CreateConnection |
class |
CreateCredentialRequest |
class |
CreateEntityTagAssignmentRequest |
class |
CreateExternalLineageRelationshipRequest |
class |
CreateExternalLocation |
class |
CreateExternalMetadataRequest |
class |
CreateFunction |
class |
CreateFunctionParameterStyle |
class |
CreateFunctionRequest |
class |
CreateFunctionRoutineBody |
class |
CreateFunctionSecurityType |
class |
CreateFunctionSqlDataAccess |
class |
CreateMetastore |
class |
CreateMetastoreAssignment |
class |
CreateMonitor |
class |
CreateOnlineTableRequest |
class |
CreatePolicyRequest |
class |
CreateRegisteredModelRequest |
class |
CreateRequestExternalLineage |
class |
CreateSchema |
class |
CreateSecretRequest |
class |
CreateStorageCredential |
class |
CreateTableConstraint |
class |
CreateTableRequest |
class |
CreateVolumeRequestContent |
class |
CredentialDependency
A credential that is dependent on a SQL object.
|
class |
CredentialInfo |
class |
CredentialPurpose |
class |
CredentialsAPI
A credential represents an authentication and authorization mechanism for accessing services on
your cloud tenant.
|
interface |
CredentialsService
A credential represents an authentication and authorization mechanism for accessing services on
your cloud tenant.
|
class |
CredentialType
Next Id: 19
|
class |
CredentialValidationResult |
class |
DatabricksGcpServiceAccount
GCP long-lived credential.
|
class |
DatabricksGcpServiceAccountRequest
GCP long-lived credential.
|
class |
DatabricksGcpServiceAccountResponse
GCP long-lived credential.
|
class |
DataSourceFormat
Data source format
|
class |
DeleteAccountMetastoreAssignmentRequest |
class |
DeleteAccountMetastoreRequest |
class |
DeleteAccountStorageCredentialRequest |
class |
DeleteAliasRequest |
class |
DeleteCatalogRequest |
class |
DeleteConnectionRequest |
class |
DeleteCredentialRequest |
class |
DeleteEntityTagAssignmentRequest |
class |
DeleteExternalLineageRelationshipRequest |
class |
DeleteExternalLocationRequest |
class |
DeleteExternalMetadataRequest |
class |
DeleteFunctionRequest |
class |
DeleteMetastoreRequest |
class |
DeleteModelVersionRequest |
class |
DeleteMonitorResponse |
class |
DeleteOnlineTableRequest |
class |
DeletePolicyRequest |
class |
DeletePolicyResponse |
class |
DeleteQualityMonitorRequest |
class |
DeleteRegisteredModelRequest |
class |
DeleteRequestExternalLineage |
class |
DeleteSchemaRequest |
class |
DeleteSecretRequest |
class |
DeleteStorageCredentialRequest |
class |
DeleteTableConstraintRequest |
class |
DeleteTableRequest |
class |
DeleteVolumeRequest |
class |
DeltaRuntimePropertiesKvPairs
Properties pertaining to the current state of the delta table as given by the commit server.
|
class |
DeltaSharingScopeEnum |
class |
Dependency
A dependency of a SQL object.
|
class |
DependencyList
A list of dependencies.
|
class |
DestinationType |
class |
DisableRequest |
class |
EffectivePermissionsList |
class |
EffectivePredictiveOptimizationFlag |
class |
EffectivePredictiveOptimizationFlagInheritedFromType |
class |
EffectivePrivilege |
class |
EffectivePrivilegeAssignment |
class |
EnablePredictiveOptimization |
class |
EnableRequest |
class |
EncryptionDetails
Encryption options that apply to clients connecting to cloud storage.
|
class |
EncryptionSettings
Encryption Settings are used to carry metadata for securable encryption at rest.
|
class |
EntityTagAssignment
Represents a tag assignment to an entity
|
class |
EntityTagAssignmentsAPI
Tags are attributes that include keys and optional values that you can use to organize and
categorize entities in Unity Catalog.
|
interface |
EntityTagAssignmentsService
Tags are attributes that include keys and optional values that you can use to organize and
categorize entities in Unity Catalog.
|
class |
ExistsRequest |
class |
ExternalLineageAPI
External Lineage APIs enable defining and managing lineage relationships between Databricks
objects and external systems.
|
class |
ExternalLineageExternalMetadata |
class |
ExternalLineageExternalMetadataInfo
Represents the external metadata object in the lineage event.
|
class |
ExternalLineageFileInfo
Represents the path information in the lineage event.
|
class |
ExternalLineageInfo
Lineage response containing lineage information of a data asset.
|
class |
ExternalLineageModelVersion |
class |
ExternalLineageModelVersionInfo
Represents the model version information in the lineage event.
|
class |
ExternalLineageObject |
class |
ExternalLineagePath |
class |
ExternalLineageRelationship |
class |
ExternalLineageRelationshipInfo |
interface |
ExternalLineageService
External Lineage APIs enable defining and managing lineage relationships between Databricks
objects and external systems.
|
class |
ExternalLineageTable |
class |
ExternalLineageTableInfo
Represents the table information in the lineage event.
|
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 |
ExternalMetadata |
class |
ExternalMetadataAPI
External Metadata objects enable customers to register and manage metadata about external systems
within Unity Catalog.
|
interface |
ExternalMetadataService
External Metadata objects enable customers to register and manage metadata about external systems
within Unity Catalog.
|
class |
FailedStatus
Detailed status of an online table.
|
class |
FileEventQueue |
class |
ForeignKeyConstraint |
class |
FunctionArgument |
class |
FunctionDependency
A function that is dependent on a SQL object.
|
class |
FunctionInfo |
class |
FunctionInfoParameterStyle |
class |
FunctionInfoRoutineBody |
class |
FunctionInfoSecurityType |
class |
FunctionInfoSqlDataAccess |
class |
FunctionParameterInfo |
class |
FunctionParameterInfos |
class |
FunctionParameterMode |
class |
FunctionParameterType |
class |
FunctionsAPI
Functions implement User-Defined Functions (UDFs) in Unity Catalog.
|
interface |
FunctionsService
Functions implement User-Defined Functions (UDFs) in Unity Catalog.
|
class |
GcpOauthToken
GCP temporary credentials for API authentication.
|
class |
GcpPubsub |
class |
GenerateTemporaryPathCredentialRequest |
class |
GenerateTemporaryPathCredentialResponse |
class |
GenerateTemporaryServiceCredentialAzureOptions
The Azure cloud options to customize the requested temporary credential
|
class |
GenerateTemporaryServiceCredentialGcpOptions
The GCP cloud options to customize the requested temporary credential
|
class |
GenerateTemporaryServiceCredentialRequest |
class |
GenerateTemporaryTableCredentialRequest |
class |
GenerateTemporaryTableCredentialResponse |
class |
GenerateTemporaryVolumeCredentialRequest
Generate volume credentials RPC
|
class |
GenerateTemporaryVolumeCredentialResponse |
class |
GetAccessRequestDestinationsRequest |
class |
GetAccountMetastoreAssignmentRequest |
class |
GetAccountMetastoreRequest |
class |
GetAccountStorageCredentialRequest |
class |
GetArtifactAllowlistRequest |
class |
GetBindingsRequest |
class |
GetByAliasRequest |
class |
GetCatalogRequest |
class |
GetCatalogWorkspaceBindingsResponse |
class |
GetConnectionRequest |
class |
GetCredentialRequest |
class |
GetEffectiveRequest |
class |
GetEntityTagAssignmentRequest |
class |
GetExternalLocationRequest |
class |
GetExternalMetadataRequest |
class |
GetFunctionRequest |
class |
GetGrantRequest |
class |
GetMetastoreRequest |
class |
GetMetastoreSummaryResponse |
class |
GetModelVersionRequest |
class |
GetOnlineTableRequest |
class |
GetPermissionsResponse |
class |
GetPolicyRequest |
class |
GetQualityMonitorRequest |
class |
GetQuotaRequest |
class |
GetQuotaResponse |
class |
GetRefreshRequest |
class |
GetRegisteredModelRequest |
class |
GetSchemaRequest |
class |
GetSecretRequest |
class |
GetStorageCredentialRequest |
class |
GetTableRequest |
class |
GetWorkspaceBindingRequest |
class |
GetWorkspaceBindingsResponse |
class |
GrantsAPI
In Unity Catalog, data is secure by default.
|
interface |
GrantsService
In Unity Catalog, data is secure by default.
|
class |
IsolationMode |
class |
LineageDirection |
class |
ListAccountMetastoreAssignmentsRequest |
class |
ListAccountMetastoreAssignmentsResponse
The metastore assignments were successfully returned.
|
class |
ListAccountStorageCredentialsRequest |
class |
ListAccountStorageCredentialsResponse
The metastore storage credentials were successfully returned.
|
class |
ListCatalogsRequest |
class |
ListCatalogsResponse |
class |
ListConnectionsRequest |
class |
ListConnectionsResponse |
class |
ListCredentialsRequest |
class |
ListCredentialsResponse |
class |
ListEntityTagAssignmentsRequest |
class |
ListEntityTagAssignmentsResponse |
class |
ListExternalLineageRelationshipsRequest |
class |
ListExternalLineageRelationshipsResponse |
class |
ListExternalLocationsRequest |
class |
ListExternalLocationsResponse |
class |
ListExternalMetadataRequest |
class |
ListExternalMetadataResponse |
class |
ListFunctionsRequest |
class |
ListFunctionsResponse |
class |
ListMetastoresRequest |
class |
ListMetastoresResponse |
class |
ListModelVersionsRequest |
class |
ListModelVersionsResponse |
class |
ListPoliciesRequest |
class |
ListPoliciesResponse |
class |
ListQuotasRequest |
class |
ListQuotasResponse |
class |
ListRefreshesRequest |
class |
ListRegisteredModelsRequest |
class |
ListRegisteredModelsResponse |
class |
ListSchemasRequest |
class |
ListSchemasResponse |
class |
ListSecretsRequest |
class |
ListSecretsResponse
Response message for ListSecrets.
|
class |
ListStorageCredentialsRequest |
class |
ListStorageCredentialsResponse |
class |
ListSummariesRequest |
class |
ListSystemSchemasRequest |
class |
ListSystemSchemasResponse |
class |
ListTablesRequest |
class |
ListTablesResponse |
class |
ListTableSummariesResponse |
class |
ListVolumesRequest |
class |
ListVolumesResponseContent |
class |
MatchColumn |
class |
MatchType
The artifact pattern matching type
|
class |
MetastoreAssignment |
class |
MetastoreInfo |
class |
MetastoresAPI
A metastore is the top-level container of objects in Unity Catalog.
|
interface |
MetastoresService
A metastore is the top-level container of objects in Unity Catalog.
|
class |
ModelVersionInfo |
class |
ModelVersionInfoStatus |
class |
ModelVersionsAPI
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
interface |
ModelVersionsService
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
class |
MonitorCronSchedule |
class |
MonitorCronSchedulePauseStatus
Source link:
https://src.dev.databricks.com/databricks/universe/-/blob/elastic-spark-common/api/messages/schedule.proto
Monitoring workflow schedule pause status.
|
class |
MonitorDataClassificationConfig
Data classification related configuration.
|
class |
MonitorDestination |
class |
MonitorInferenceLog |
class |
MonitorInferenceLogProblemType |
class |
MonitorInfo |
class |
MonitorInfoStatus |
class |
MonitorMetric
Custom metric definition.
|
class |
MonitorMetricType
Can only be one of ``\"CUSTOM_METRIC_TYPE_AGGREGATE\"``, ``\"CUSTOM_METRIC_TYPE_DERIVED\"``, or
``\"CUSTOM_METRIC_TYPE_DRIFT\"``.
|
class |
MonitorNotifications |
class |
MonitorRefreshInfo |
class |
MonitorRefreshInfoState
The current state of the refresh.
|
class |
MonitorRefreshInfoTrigger |
class |
MonitorRefreshListResponse |
class |
MonitorSnapshot
Snapshot analysis configuration
|
class |
MonitorTimeSeries
Time series analysis configuration.
|
class |
NamedTableConstraint |
class |
NotificationDestination |
class |
OnlineTable
Online Table information.
|
class |
OnlineTablesAPI
Online tables provide lower latency and higher QPS access to data from Delta tables.
|
class |
OnlineTableSpec
Specification of an online table.
|
class |
OnlineTableSpecContinuousSchedulingPolicy |
class |
OnlineTableSpecTriggeredSchedulingPolicy |
interface |
OnlineTablesService
Online tables provide lower latency and higher QPS access to data from Delta tables.
|
class |
OnlineTableState
The state of an online table.
|
class |
OnlineTableStatus
Status of an online table.
|
class |
OptionSpec
Spec of an allowed option on a securable kind and its attributes.
|
class |
OptionSpecOauthStage
During the OAuth flow, specifies which stage the option should be displayed in the UI.
|
class |
OptionSpecOptionType
Type of the option, we purposely follow JavaScript types so that the UI can map the options to JS
types. https://www.w3schools.com/js/js_datatypes.asp Enum is a special case that it's just string
with selections.
|
class |
PathOperation |
class |
PermissionsChange |
class |
PipelineProgress
Progress information of the Online Table data synchronization pipeline.
|
class |
PoliciesAPI
Attribute-Based Access Control (ABAC) provides high leverage governance for enforcing compliance
policies in Unity Catalog.
|
interface |
PoliciesService
Attribute-Based Access Control (ABAC) provides high leverage governance for enforcing compliance
policies in Unity Catalog.
|
class |
PolicyFunctionArgument
A positional argument passed to a row filter or column mask function.
|
class |
PolicyInfo |
class |
PolicyType |
class |
PrimaryKeyConstraint |
class |
Principal |
class |
PrincipalType |
class |
Privilege |
class |
PrivilegeAssignment |
class |
ProvisioningInfo
Status of an asynchronously provisioned resource.
|
class |
ProvisioningInfoState |
class |
ProvisioningStatus
Detailed status of an online table.
|
class |
QualityMonitorsAPI
Deprecated: Please use the Data Quality Monitors API instead (REST:
/api/data-quality/v1/monitors), which manages both Data Profiling and Anomaly Detection.
|
interface |
QualityMonitorsService
Deprecated: Please use the Data Quality Monitors API instead (REST:
/api/data-quality/v1/monitors), which manages both Data Profiling and Anomaly Detection.
|
class |
QuotaInfo |
class |
R2Credentials
R2 temporary credentials for API authentication.
|
class |
ReadVolumeRequest |
class |
RegenerateDashboardRequest |
class |
RegenerateDashboardResponse |
class |
RegisteredModelAlias |
class |
RegisteredModelInfo |
class |
RegisteredModelsAPI
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
interface |
RegisteredModelsService
Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
|
class |
ResourceQuotasAPI
Unity Catalog enforces resource quotas on all securable objects, which limits the number of
resources that can be created.
|
interface |
ResourceQuotasService
Unity Catalog enforces resource quotas on all securable objects, which limits the number of
resources that can be created.
|
class |
RfaAPI
Request for Access enables users to request access for Unity Catalog securables.
|
interface |
RfaService
Request for Access enables users to request access for Unity Catalog securables.
|
class |
RowFilterOptions |
class |
RunRefreshRequest |
class |
SchemaInfo
Next ID: 45
|
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 |
Secret
A secret stored in Unity Catalog.
|
class |
SecretsUcAPI
A secret is a Unity Catalog securable object that stores sensitive credential data (such as
passwords, tokens, and keys) within a three-level namespace
(**catalog_name.schema_name.secret_name**).
|
interface |
SecretsUcService
A secret is a Unity Catalog securable object that stores sensitive credential data (such as
passwords, tokens, and keys) within a three-level namespace
(**catalog_name.schema_name.secret_name**).
|
class |
Securable
Generic definition of a securable, which is uniquely defined in a metastore by its type and full
name.
|
class |
SecurableKind
Specific variant of a SecurableType: identifies the concrete implementation or backing system for
a UC securable (e.g.
|
class |
SecurableKindManifest
Manifest of a specific securable kind.
|
class |
SecurablePermissions |
class |
SecurableType
The type of Unity Catalog securable.
|
class |
SetArtifactAllowlist |
class |
SetRegisteredModelAliasRequest |
class |
SpecialDestination |
class |
SseEncryptionDetails
Server-Side Encryption properties for clients communicating with AWS s3.
|
class |
SseEncryptionDetailsAlgorithm |
class |
StorageCredentialInfo |
class |
StorageCredentialsAPI
A storage credential represents an authentication and authorization mechanism for accessing data
stored on your cloud tenant.
|
interface |
StorageCredentialsService
A storage credential represents an authentication and authorization mechanism for accessing data
stored on your cloud tenant.
|
class |
SystemSchemaInfo |
class |
SystemSchemasAPI
A system schema is a schema that lives within the system catalog.
|
interface |
SystemSchemasService
A system schema is a schema that lives within the system catalog.
|
class |
SystemType |
class |
TableConstraint
A table constraint, as defined by *one* of the following fields being set:
__primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.
|
class |
TableConstraintsAPI
Primary key and foreign key constraints encode relationships between fields in tables.
|
interface |
TableConstraintsService
Primary key and foreign key constraints encode relationships between fields in tables.
|
class |
TableDependency
A table that is dependent on a SQL object.
|
class |
TableExistsResponse |
class |
TableInfo |
class |
TableOperation |
class |
TableRowFilter |
class |
TablesAPI
A table resides in the third layer of Unity Catalog’s three-level namespace.
|
interface |
TablesService
A table resides in the third layer of Unity Catalog’s three-level namespace.
|
class |
TableSummary |
class |
TableType |
class |
TagAssignmentSourceType
Enum representing the source type of a tag assignment
|
class |
TagKeyValue |
class |
TemporaryCredentials |
class |
TemporaryPathCredentialsAPI
Temporary Path Credentials refer to short-lived, downscoped credentials used to access external
cloud storage locations registered in Databricks.
|
interface |
TemporaryPathCredentialsService
Temporary Path Credentials refer to short-lived, downscoped credentials used to access external
cloud storage locations registered in Databricks.
|
class |
TemporaryTableCredentialsAPI
Temporary Table Credentials refer to short-lived, downscoped credentials used to access cloud
storage locations where table data is stored in Databricks.
|
interface |
TemporaryTableCredentialsService
Temporary Table Credentials refer to short-lived, downscoped credentials used to access cloud
storage locations where table data is stored in Databricks.
|
class |
TemporaryVolumeCredentialsAPI
Temporary Volume Credentials refer to short-lived, downscoped credentials used to access cloud
storage locations where volume data is stored in Databricks.
|
interface |
TemporaryVolumeCredentialsService
Temporary Volume Credentials refer to short-lived, downscoped credentials used to access cloud
storage locations where volume data is stored in Databricks.
|
class |
TriggeredUpdateStatus
Detailed status of an online table.
|
class |
UnassignRequest |
class |
UpdateAccessRequestDestinationsRequest |
class |
UpdateAccountsMetastore |
class |
UpdateAccountsStorageCredential |
class |
UpdateCatalog |
class |
UpdateCatalogWorkspaceBindingsResponse |
class |
UpdateConnection |
class |
UpdateCredentialRequest |
class |
UpdateEntityTagAssignmentRequest |
class |
UpdateExternalLineageRelationshipRequest |
class |
UpdateExternalLocation |
class |
UpdateExternalMetadataRequest |
class |
UpdateFunction |
class |
UpdateMetastore |
class |
UpdateMetastoreAssignment |
class |
UpdateModelVersionRequest |
class |
UpdateMonitor |
class |
UpdatePermissions |
class |
UpdatePermissionsResponse |
class |
UpdatePolicyRequest |
class |
UpdateRegisteredModelRequest |
class |
UpdateRequestExternalLineage |
class |
UpdateSchema |
class |
UpdateSecretRequest |
class |
UpdateStorageCredential |
class |
UpdateTableRequest |
class |
UpdateVolumeRequestContent |
class |
UpdateWorkspaceBindings |
class |
UpdateWorkspaceBindingsParameters |
class |
UpdateWorkspaceBindingsResponse
A list of workspace IDs that are bound to the securable
|
class |
ValidateCredentialRequest
Next ID: 18
|
class |
ValidateCredentialResponse |
class |
ValidateCredentialResult
A enum represents the result of the file operation
|
class |
ValidateStorageCredential |
class |
ValidateStorageCredentialResponse |
class |
ValidationResult |
class |
ValidationResultOperation
A enum represents the file operation performed on the external location with the storage
credential
|
class |
ValidationResultResult
A enum represents the result of the file operation
|
class |
VolumeInfo |
class |
VolumeOperation |
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 |
WorkspaceBinding |
class |
WorkspaceBindingBindingType
Using `BINDING_TYPE_` prefix here to avoid conflict with `TableOperation` enum in
`credentials_common.proto`.
|
class |
WorkspaceBindingsAPI
A securable in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
interface |
WorkspaceBindingsService
A securable in Databricks can be configured as __OPEN__ or __ISOLATED__.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CleanRoom |
class |
CleanRoomAccessRestricted |
class |
CleanRoomAsset
Metadata of the clean room asset
|
class |
CleanRoomAssetAssetType |
class |
CleanRoomAssetForeignTable |
class |
CleanRoomAssetForeignTableLocalDetails |
class |
CleanRoomAssetNotebook |
class |
CleanRoomAssetRevisionsAPI
Clean Room Asset Revisions denote new versions of uploaded assets (e.g. notebooks) in the clean
room.
|
interface |
CleanRoomAssetRevisionsService
Clean Room Asset Revisions denote new versions of uploaded assets (e.g. notebooks) in the clean
room.
|
class |
CleanRoomAssetsAPI
Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared with
the clean room.
|
interface |
CleanRoomAssetsService
Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared with
the clean room.
|
class |
CleanRoomAssetStatusEnum |
class |
CleanRoomAssetTable |
class |
CleanRoomAssetTableLocalDetails |
class |
CleanRoomAssetView |
class |
CleanRoomAssetViewLocalDetails |
class |
CleanRoomAssetVolumeLocalDetails |
class |
CleanRoomAutoApprovalRule |
class |
CleanRoomAutoApprovalRuleAuthorScope |
class |
CleanRoomAutoApprovalRulesAPI
Clean room auto-approval rules automatically create an approval on your behalf when an asset
(e.g. notebook) meeting specific criteria is shared in a clean room.
|
interface |
CleanRoomAutoApprovalRulesService
Clean room auto-approval rules automatically create an approval on your behalf when an asset
(e.g. notebook) meeting specific criteria is shared in a clean room.
|
class |
CleanRoomCollaborator
Publicly visible clean room collaborator.
|
class |
CleanRoomNotebookReview |
class |
CleanRoomNotebookReviewNotebookReviewState |
class |
CleanRoomNotebookReviewNotebookReviewSubReason |
class |
CleanRoomNotebookTaskRun
Stores information about a single task run.
|
class |
CleanRoomOutputCatalog |
class |
CleanRoomOutputCatalogOutputCatalogStatus |
class |
CleanRoomRemoteDetail
Publicly visible central clean room details.
|
class |
CleanRoomsAPI
A clean room uses Delta Sharing and serverless compute to provide a secure and privacy-protecting
environment where multiple parties can work together on sensitive enterprise data without direct
access to each other's data.
|
interface |
CleanRoomsService
A clean room uses Delta Sharing and serverless compute to provide a secure and privacy-protecting
environment where multiple parties can work together on sensitive enterprise data without direct
access to each other's data.
|
class |
CleanRoomStatusEnum |
class |
CleanRoomTaskRunsAPI
Clean room task runs are the executions of notebooks in a clean room.
|
interface |
CleanRoomTaskRunsService
Clean room task runs are the executions of notebooks in a clean room.
|
class |
CollaboratorJobRunInfo |
class |
ComplianceSecurityProfile
The compliance security profile used to process regulated data following compliance standards.
|
class |
CreateCleanRoomAssetRequest |
class |
CreateCleanRoomAssetReviewRequest |
class |
CreateCleanRoomAssetReviewResponse |
class |
CreateCleanRoomAutoApprovalRuleRequest |
class |
CreateCleanRoomOutputCatalogRequest |
class |
CreateCleanRoomOutputCatalogResponse |
class |
CreateCleanRoomRequest |
class |
DeleteCleanRoomAssetRequest |
class |
DeleteCleanRoomAutoApprovalRuleRequest |
class |
DeleteCleanRoomRequest |
class |
GetCleanRoomAssetRequest |
class |
GetCleanRoomAssetRevisionRequest |
class |
GetCleanRoomAutoApprovalRuleRequest |
class |
GetCleanRoomRequest |
class |
ListCleanRoomAssetRevisionsRequest |
class |
ListCleanRoomAssetRevisionsResponse |
class |
ListCleanRoomAssetsRequest |
class |
ListCleanRoomAssetsResponse |
class |
ListCleanRoomAutoApprovalRulesRequest |
class |
ListCleanRoomAutoApprovalRulesResponse |
class |
ListCleanRoomNotebookTaskRunsRequest |
class |
ListCleanRoomNotebookTaskRunsResponse |
class |
ListCleanRoomsRequest |
class |
ListCleanRoomsResponse |
class |
NotebookVersionReview |
class |
UpdateCleanRoomAssetRequest |
class |
UpdateCleanRoomAutoApprovalRuleRequest |
class |
UpdateCleanRoomRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
AddInstanceProfile |
class |
Adlsgen2Info
A storage location in Adls Gen2
|
class |
AutoScale |
class |
AwsAttributes
Attributes set during cluster creation which are related to Amazon Web Services.
|
class |
AwsAvailability
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
class |
AzureAttributes
Attributes set during cluster creation which are related to Microsoft Azure.
|
class |
AzureAvailability
Availability type used for all subsequent nodes past the `first_on_demand` ones.
|
class |
CancelCommand |
class |
ChangeClusterOwner |
class |
ClientsTypes |
class |
CloneCluster |
class |
CloudProviderNodeInfo |
class |
CloudProviderNodeStatus |
class |
ClusterAccessControlRequest |
class |
ClusterAccessControlResponse |
class |
ClusterAttributes
Common set of attributes set during cluster creation.
|
class |
ClusterCompliance |
class |
ClusterDetails
Describes all of the metadata about a single Spark cluster in Databricks.
|
class |
ClusterEvent |
class |
ClusterLibraryStatuses |
class |
ClusterLogConf
Cluster log delivery config
|
class |
ClusterPermission |
class |
ClusterPermissionLevel
Permission level
|
class |
ClusterPermissions |
class |
ClusterPermissionsDescription |
class |
ClusterPermissionsRequest |
class |
ClusterPoliciesAPI
You can use cluster policies to control users' ability to configure clusters based on a set of
rules.
|
interface |
ClusterPoliciesService
You can use cluster policies to control users' ability to configure clusters based on a set of
rules.
|
class |
ClusterPolicyAccessControlRequest |
class |
ClusterPolicyAccessControlResponse |
class |
ClusterPolicyPermission |
class |
ClusterPolicyPermissionLevel
Permission level
|
class |
ClusterPolicyPermissions |
class |
ClusterPolicyPermissionsDescription |
class |
ClusterPolicyPermissionsRequest |
class |
ClustersAPI
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
class |
ClusterSettingsChange
Represents a change to the cluster settings required for the cluster to become compliant with its
policy.
|
class |
ClusterSize |
class |
ClusterSource
Determines whether the cluster was created by a user through the UI, created by the Databricks
Jobs Scheduler, or through an API request.
|
class |
ClusterSpec
Contains a snapshot of the latest user specified settings that were used to create/edit the
cluster.
|
interface |
ClustersService
The Clusters API allows you to create, start, edit, list, terminate, and delete clusters.
|
class |
ClusterStatus |
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 |
class |
CommandStatusResponse |
class |
ConfidentialComputeType
Confidential computing technology for GCP instances.
|
class |
ContextStatus |
class |
ContextStatusRequest |
class |
ContextStatusResponse |
class |
CreateCluster |
class |
CreateClusterResponse |
class |
CreateContext |
class |
Created |
class |
CreateInstancePool |
class |
CreateInstancePoolResponse |
class |
CreatePolicy |
class |
CreatePolicyResponse |
class |
CreateResponse |
class |
CustomPolicyTag |
class |
DataPlaneEventDetails |
class |
DataPlaneEventDetailsEventType |
class |
DataSecurityMode
Data security mode decides what data governance model to use when accessing data from a cluster.
|
class |
DbfsStorageInfo
A storage location in DBFS
|
class |
DeleteCluster |
class |
DeleteGlobalInitScriptRequest |
class |
DeleteInstancePool |
class |
DeletePolicy |
class |
DestroyContext |
class |
DiskSpec
Describes the disks that are launched for each instance in the spark cluster.
|
class |
DiskType
Describes the disk type.
|
class |
DiskTypeAzureDiskVolumeType
All Azure Disk types that Databricks supports.
|
class |
DiskTypeEbsVolumeType
All EBS volume types that Databricks supports.
|
class |
DockerBasicAuth |
class |
DockerImage |
class |
EbsVolumeType
All EBS volume types that Databricks supports.
|
class |
EditCluster |
class |
EditInstancePool |
class |
EditPolicy |
class |
EnforceClusterComplianceRequest |
class |
EnforceClusterComplianceResponse |
class |
Environment
The environment entity used to preserve serverless environment side panel, jobs' environment for
non-notebook task, and SDP's environment for classic and serverless pipelines.
|
class |
EventDetails |
class |
EventDetailsCause
The cause of a change in target size.
|
class |
EventType |
class |
GcpAttributes
Attributes set during cluster creation which are related to GCP.
|
class |
GcpAvailability
This field determines whether the instance pool will contain preemptible VMs, on-demand VMs, or
preemptible VMs with a fallback to on-demand VMs if the former is unavailable.
|
class |
GcsStorageInfo
A storage location in Google Cloud Platform's GCS
|
class |
GetClusterComplianceRequest |
class |
GetClusterComplianceResponse |
class |
GetClusterPermissionLevelsRequest |
class |
GetClusterPermissionLevelsResponse |
class |
GetClusterPermissionsRequest |
class |
GetClusterPolicyPermissionLevelsRequest |
class |
GetClusterPolicyPermissionLevelsResponse |
class |
GetClusterPolicyPermissionsRequest |
class |
GetClusterPolicyRequest |
class |
GetClusterRequest |
class |
GetEvents |
class |
GetEventsOrder |
class |
GetEventsResponse |
class |
GetGlobalInitScriptRequest |
class |
GetInstancePool |
class |
GetInstancePoolPermissionLevelsRequest |
class |
GetInstancePoolPermissionLevelsResponse |
class |
GetInstancePoolPermissionsRequest |
class |
GetInstancePoolRequest |
class |
GetPolicyFamilyRequest |
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 |
HardwareAcceleratorType
HardwareAcceleratorType: The type of hardware accelerator to use for compute workloads.
|
class |
InitScriptEventDetails |
class |
InitScriptExecutionDetailsInitScriptExecutionStatus
Result of attempted script execution
|
class |
InitScriptInfo
Config for an individual init script Next ID: 11
|
class |
InitScriptInfoAndExecutionDetails |
class |
InstallLibraries |
class |
InstancePoolAccessControlRequest |
class |
InstancePoolAccessControlResponse |
class |
InstancePoolAndStats |
class |
InstancePoolAwsAttributes
Attributes set during instance pool creation which are related to Amazon Web Services.
|
class |
InstancePoolAwsAttributesAvailability
The set of AWS availability types supported when setting up nodes for a cluster.
|
class |
InstancePoolAzureAttributes
Attributes set during instance pool creation which are related to Azure.
|
class |
InstancePoolAzureAttributesAvailability
The set of Azure availability types supported when setting up nodes for a cluster.
|
class |
InstancePoolGcpAttributes
Attributes set during instance pool creation which are related to GCP.
|
class |
InstancePoolPermission |
class |
InstancePoolPermissionLevel
Permission level
|
class |
InstancePoolPermissions |
class |
InstancePoolPermissionsDescription |
class |
InstancePoolPermissionsRequest |
class |
InstancePoolsAPI
Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use
cloud instances which reduces a cluster start and auto-scaling times.
|
interface |
InstancePoolsService
Instance Pools API are used to create, edit, delete and list instance pools by using ready-to-use
cloud instances which reduces a cluster start and auto-scaling times.
|
class |
InstancePoolState
The state of a Cluster.
|
class |
InstancePoolStats |
class |
InstancePoolStatus |
class |
InstanceProfile |
class |
InstanceProfilesAPI
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
interface |
InstanceProfilesService
The Instance Profiles API allows admins to add, list, and remove instance profiles that users can
launch clusters with.
|
class |
Kind
The kind of compute described by this compute specification.
|
class |
Language |
class |
LibrariesAPI
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
interface |
LibrariesService
The Libraries API allows you to install and uninstall libraries and get the status of libraries
on a cluster.
|
class |
Library |
class |
LibraryFullStatus
The status of the library on a specific cluster.
|
class |
LibraryInstallStatus
The status of a library on a specific cluster.
|
class |
ListAllClusterLibraryStatusesResponse |
class |
ListAvailableZonesResponse |
class |
ListClusterCompliancesRequest |
class |
ListClusterCompliancesResponse |
class |
ListClusterPoliciesRequest |
class |
ListClustersFilterBy |
class |
ListClustersRequest |
class |
ListClustersResponse |
class |
ListClustersSortBy |
class |
ListClustersSortByDirection |
class |
ListClustersSortByField |
class |
ListGlobalInitScriptsResponse |
class |
ListInstancePools |
class |
ListInstanceProfilesResponse |
class |
ListNodeTypesResponse |
class |
ListPoliciesResponse |
class |
ListPolicyFamiliesRequest |
class |
ListPolicyFamiliesResponse |
class |
ListSortColumn |
class |
ListSortOrder |
class |
LocalFileInfo |
class |
LogAnalyticsInfo |
class |
LogSyncStatus
The log delivery status
|
class |
MavenLibrary |
class |
NodeInstanceType
This structure embodies the machine type that hosts spark containers Note: this should be an
internal data structure for now It is defined in proto in case we want to send it over the wire
in the future (which is likely)
|
class |
NodeType
A description of a Spark node type including both the dimensions of the node and the instance
type on which it will be hosted.
|
class |
NodeTypeFlexibility
Configuration for flexible node types, allowing fallback to alternate node types during cluster
launch and upscale.
|
class |
PendingInstanceError
Error message of a failed pending instances
|
class |
PermanentDeleteCluster |
class |
PinCluster |
class |
Policy
Describes a Cluster Policy entity.
|
class |
PolicyComplianceForClustersAPI
The policy compliance APIs allow you to view and manage the policy compliance status of clusters
in your workspace.
|
interface |
PolicyComplianceForClustersService
The policy compliance APIs allow you to view and manage the policy compliance status of clusters
in your workspace.
|
class |
PolicyFamiliesAPI
View available policy families.
|
interface |
PolicyFamiliesService
View available policy families.
|
class |
PolicyFamily |
class |
PythonPyPiLibrary |
class |
RCranLibrary |
class |
RemoveInstanceProfile |
class |
ResizeCluster |
class |
RestartCluster |
class |
Results |
class |
ResultType |
class |
RuntimeEngine |
class |
S3StorageInfo
A storage location in Amazon S3
|
class |
SparkNode
Describes a specific Spark driver or executor.
|
class |
SparkNodeAwsAttributes
Attributes specific to AWS for a Spark node.
|
class |
SparkVersion |
class |
StartCluster |
class |
State
The state of a Cluster.
|
class |
TerminationReason |
class |
TerminationReasonCode
The status code indicating why the cluster was terminated
|
class |
TerminationReasonType
type of the termination
|
class |
UninstallLibraries |
class |
UnpinCluster |
class |
UpdateCluster |
class |
UpdateClusterResource |
class |
VolumesStorageInfo
A storage location back by UC Volumes.
|
class |
WorkloadType
Cluster Attributes showing for clusters workload types.
|
class |
WorkspaceStorageInfo
A storage location in Workspace Filesystem (WSFS)
|
| Modifier and Type | Class and Description |
|---|---|
class |
AutoTaggingConfig
Auto-tagging configuration for a classification tag.
|
class |
AutoTaggingConfigAutoTaggingMode
Auto-tagging mode.
|
class |
CatalogConfig
Data Classification configuration for a Unity Catalog catalog.
|
class |
CatalogConfigSchemaNames
Wrapper message for a list of schema names.
|
class |
CreateCatalogConfigRequest |
class |
DataClassificationAPI
Manage data classification for Unity Catalog catalogs.
|
interface |
DataClassificationService
Manage data classification for Unity Catalog catalogs.
|
class |
DeleteCatalogConfigRequest |
class |
GetCatalogConfigRequest |
class |
UpdateCatalogConfigRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
AggregationGranularity
The granularity for aggregating data into time windows based on their timestamp.
|
class |
AnomalyDetectionConfig
Anomaly Detection Configurations.
|
class |
CancelRefreshRequest
Request to cancel a refresh.
|
class |
CancelRefreshResponse
Response to cancelling a refresh.
|
class |
CreateMonitorRequest |
class |
CreateRefreshRequest |
class |
CronSchedule
The data quality monitoring workflow cron schedule.
|
class |
CronSchedulePauseStatus
The data quality monitoring workflow cron schedule pause status.
|
class |
DataProfilingConfig
Data Profiling Configurations.
|
class |
DataProfilingCustomMetric
Custom metric definition.
|
class |
DataProfilingCustomMetricType
The custom metric type.
|
class |
DataProfilingStatus
The status of the data profiling monitor.
|
class |
DataQualityAPI
Manage the data quality of Unity Catalog objects (currently support `schema` and `table`)
|
interface |
DataQualityService
Manage the data quality of Unity Catalog objects (currently support `schema` and `table`)
This is the high-level interface, that contains generated methods.
|
class |
DeleteMonitorRequest |
class |
DeleteRefreshRequest |
class |
GetMonitorRequest |
class |
GetRefreshRequest |
class |
InferenceLogConfig
Inference log configuration.
|
class |
InferenceProblemType
Inference problem type the model aims to solve.
|
class |
ListMonitorRequest |
class |
ListMonitorResponse
Response for listing Monitors.
|
class |
ListRefreshRequest |
class |
ListRefreshResponse
Response for listing refreshes.
|
class |
Monitor
Monitor for the data quality of unity catalog entities such as schema or table.
|
class |
NotificationDestination
Destination of the data quality monitoring notification.
|
class |
NotificationSettings
Settings for sending notifications on the data quality monitoring.
|
class |
Refresh
The Refresh object gives information on a refresh of the data quality monitoring pipeline.
|
class |
RefreshState
The state of the refresh.
|
class |
RefreshTrigger
The trigger of the refresh.
|
class |
SnapshotConfig
Snapshot analysis configuration.
|
class |
TimeSeriesConfig
Time series analysis configuration.
|
class |
UpdateMonitorRequest |
class |
UpdateRefreshRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
CreateFailoverGroupRequest |
class |
CreateStableUrlRequest |
class |
DeleteFailoverGroupRequest |
class |
DeleteStableUrlRequest |
class |
DisasterRecoveryAPI
Manage disaster recovery configurations and execute failover operations.
|
interface |
DisasterRecoveryService
Manage disaster recovery configurations and execute failover operations.
|
class |
FailoverFailoverGroupRequest
Request to failover a failover group to a new primary region.
|
class |
FailoverFailoverGroupRequestFailoverType
The type of failover to perform.
|
class |
FailoverGroup
A failover group manages disaster recovery across workspace sets, coordinating UCDR and CPDR
replication.
|
class |
FailoverGroupState
The aggregate state of a FailoverGroup.
|
class |
GetFailoverGroupRequest |
class |
GetStableUrlRequest |
class |
ListFailoverGroupsRequest |
class |
ListFailoverGroupsResponse
Response for listing failover groups.
|
class |
ListStableUrlsRequest |
class |
ListStableUrlsResponse
Response for listing stable URLs.
|
class |
LocationMapping
A location mapping identified by a name, with URIs per region.
|
class |
LocationMappingEntry
A single entry in a location mapping, mapping a region to a storage URI.
|
class |
StableUrl
A stable URL provides a failover-aware endpoint for accessing a workspace.
|
class |
UcCatalog
A Unity Catalog catalog to replicate.
|
class |
UcReplicationConfig
Unity Catalog replication configuration (top-level, not per-set).
|
class |
UpdateFailoverGroupRequest |
class |
WorkspaceSet
A set of workspaces that replicate to each other across regions.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BaseEnvironmentType
If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto
|
class |
CreateWorkspaceBaseEnvironmentOperation
Wrapper for interacting with a long-running createWorkspaceBaseEnvironment operation.
|
class |
CreateWorkspaceBaseEnvironmentRequest |
class |
DatabricksServiceExceptionWithDetailsProto
Databricks Error that is returned by all Databricks APIs.
|
class |
DefaultWorkspaceBaseEnvironment
A singleton resource representing the default workspace base environment configuration.
|
class |
DeleteWorkspaceBaseEnvironmentRequest |
class |
EnvironmentsAPI
APIs to manage environment resources.
|
interface |
EnvironmentsService
APIs to manage environment resources.
|
class |
ErrorCode
Error codes returned by Databricks APIs to indicate specific failure conditions.
|
class |
GetDefaultWorkspaceBaseEnvironmentRequest |
class |
GetOperationRequest |
class |
GetWorkspaceBaseEnvironmentRequest |
class |
ListWorkspaceBaseEnvironmentsRequest |
class |
ListWorkspaceBaseEnvironmentsResponse
Response message for ListWorkspaceBaseEnvironments.
|
class |
Operation
This resource represents a long-running operation that is the result of a network API call.
|
class |
RefreshWorkspaceBaseEnvironmentOperation
Wrapper for interacting with a long-running refreshWorkspaceBaseEnvironment operation.
|
class |
RefreshWorkspaceBaseEnvironmentRequest
Request message for RefreshWorkspaceBaseEnvironments.
|
class |
UpdateDefaultWorkspaceBaseEnvironmentRequest |
class |
UpdateWorkspaceBaseEnvironmentOperation
Wrapper for interacting with a long-running updateWorkspaceBaseEnvironment operation.
|
class |
UpdateWorkspaceBaseEnvironmentRequest |
class |
WorkspaceBaseEnvironment
A WorkspaceBaseEnvironment defines a workspace-level environment configuration consisting of an
environment version and a list of dependencies.
|
class |
WorkspaceBaseEnvironmentCacheStatus
Status of the environment materialization.
|
class |
WorkspaceBaseEnvironmentOperationMetadata
Metadata for the WorkspaceBaseEnvironment long-running operations.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AddBlock |
class |
Close |
class |
Create |
class |
CreateDirectoryRequest |
class |
CreateResponse |
class |
DbfsAPI
DBFS API makes it simple to interact with various data sources without having to include a users
credentials every time to read a file.
|
interface |
DbfsService
DBFS API makes it simple to interact with various data sources without having to include a users
credentials every time to read a file.
|
class |
Delete |
class |
DeleteDirectoryRequest |
class |
DeleteFileRequest |
class |
DirectoryEntry |
class |
DownloadRequest |
class |
DownloadResponse |
class |
FileInfo |
class |
FilesAPI
The Files API is a standard HTTP API that allows you to read, write, list, and delete files and
directories by referring to their URI.
|
interface |
FilesService
The Files API is a standard HTTP API that allows you to read, write, list, and delete files and
directories by referring to their URI.
|
class |
GetDirectoryMetadataRequest |
class |
GetMetadataRequest |
class |
GetMetadataResponse |
class |
GetStatusRequest |
class |
ListDbfsRequest |
class |
ListDirectoryContentsRequest |
class |
ListDirectoryResponse |
class |
ListStatusResponse |
class |
MkDirs |
class |
Move |
class |
Put |
class |
ReadDbfsRequest |
class |
ReadResponse |
class |
UploadRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
AccessControlAPI
Rule based Access Control for Databricks Resources.
|
class |
AccessControlRequest |
class |
AccessControlResponse |
interface |
AccessControlService
Rule based Access Control for Databricks Resources.
|
class |
AccountAccessControlAPI
These APIs manage access rules on resources in an account.
|
class |
AccountAccessControlProxyAPI
These APIs manage access rules on resources in an account.
|
interface |
AccountAccessControlProxyService
These APIs manage access rules on resources in an account.
|
interface |
AccountAccessControlService
These APIs manage access rules on resources in an account.
|
class |
AccountGroup |
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 |
AccountGroupsV2API
Groups simplify identity management, making it easier to assign access to Databricks account,
data, and other securable objects.
|
interface |
AccountGroupsV2Service
Groups simplify identity management, making it easier to assign access to Databricks account,
data, and other securable objects.
|
class |
AccountServicePrincipal |
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 |
AccountServicePrincipalsV2API
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
interface |
AccountServicePrincipalsV2Service
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
AccountUser |
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 |
AccountUsersV2API
User identities recognized by Databricks and represented by email addresses.
|
interface |
AccountUsersV2Service
User identities recognized by Databricks and represented by email addresses.
|
class |
Actor
represents an identity trying to access a resource - user or a service principal group can be a
principal of a permission set assignment but an actor is always a user or a service principal
|
class |
CheckPolicyRequest |
class |
CheckPolicyResponse |
class |
ComplexValue |
class |
ConsistencyToken |
class |
CreateAccountGroupRequest |
class |
CreateAccountServicePrincipalRequest |
class |
CreateAccountUserRequest |
class |
CreateGroupRequest |
class |
CreateServicePrincipalRequest |
class |
CreateUserRequest |
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 |
class |
DeleteAccountServicePrincipalRequest |
class |
DeleteAccountUserRequest |
class |
DeleteGroupRequest |
class |
DeleteServicePrincipalRequest |
class |
DeleteUserRequest |
class |
DeleteWorkspaceAssignmentRequest |
class |
GetAccountGroupRequest |
class |
GetAccountServicePrincipalRequest |
class |
GetAccountUserRequest |
class |
GetAssignableRolesForResourceRequest |
class |
GetAssignableRolesForResourceResponse |
class |
GetGroupRequest |
class |
GetPasswordPermissionLevelsRequest |
class |
GetPasswordPermissionLevelsResponse |
class |
GetPasswordPermissionsRequest |
class |
GetPermissionLevelsRequest |
class |
GetPermissionLevelsResponse |
class |
GetPermissionRequest |
class |
GetRuleSetRequest |
class |
GetServicePrincipalRequest |
class |
GetSortOrder |
class |
GetUserRequest |
class |
GetWorkspaceAssignmentRequest |
class |
GrantRule |
class |
Group |
class |
GroupsAPI
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
class |
GroupSchema |
interface |
GroupsService
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
class |
GroupsV2API
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
interface |
GroupsV2Service
Groups simplify identity management, making it easier to assign access to Databricks workspace,
data, and other securable objects.
|
class |
ListAccountGroupsRequest |
class |
ListAccountGroupsResponse |
class |
ListAccountServicePrincipalsRequest |
class |
ListAccountServicePrincipalsResponse |
class |
ListAccountUsersRequest |
class |
ListAccountUsersResponse |
class |
ListGroupsRequest |
class |
ListGroupsResponse |
class |
ListResponseSchema |
class |
ListServicePrincipalResponse |
class |
ListServicePrincipalsRequest |
class |
ListSortOrder |
class |
ListUsersRequest |
class |
ListUsersResponse |
class |
ListWorkspaceAssignmentRequest |
class |
MigratePermissionsRequest |
class |
MigratePermissionsResponse |
class |
Name |
class |
ObjectPermissions |
class |
PartialUpdate |
class |
PasswordAccessControlRequest |
class |
PasswordAccessControlResponse |
class |
PasswordPermission |
class |
PasswordPermissionLevel
Permission level
|
class |
PasswordPermissions |
class |
PasswordPermissionsDescription |
class |
PasswordPermissionsRequest |
class |
Patch |
class |
PatchAccountGroupRequest |
class |
PatchAccountServicePrincipalRequest |
class |
PatchAccountUserRequest |
class |
PatchGroupRequest |
class |
PatchOp
Type of patch operation.
|
class |
PatchSchema |
class |
PatchServicePrincipalRequest |
class |
PatchUserRequest |
class |
Permission |
class |
PermissionAssignment
The output format for existing workspace PermissionAssignment records, which contains some info
for user consumption.
|
class |
PermissionAssignments |
class |
PermissionLevel
Permission level
|
class |
PermissionMigrationAPI
APIs for migrating acl permissions, used only by the ucx tool:
https://github.com/databrickslabs/ucx
|
interface |
PermissionMigrationService
APIs for migrating acl permissions, used only by the ucx tool:
https://github.com/databrickslabs/ucx
This is the high-level interface, that contains generated methods.
|
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. * **[Apps permissions](:service:apps)** — Manage which users
can manage or use apps. * **[Cluster permissions](:service:clusters)** — Manage which users can
manage, restart, or attach to clusters. * **[Cluster policy
permissions](:service:clusterpolicies)** — Manage which users can use cluster policies. *
**[Spark Declarative Pipelines permissions](:service:pipelines)** — Manage which users can view,
manage, run, cancel, or own a Spark Declarative Pipeline. * **[Job permissions](:service:jobs)**
— Manage which users can view, manage, trigger, cancel, or own a job. * **[MLflow experiment
permissions](:service:experiments)** — Manage which users can read, edit, or manage MLflow
experiments. * **[MLflow registered model permissions](:service:modelregistry)** — Manage which
users can read, edit, or manage MLflow registered models. * **[Instance Pool
permissions](:service:instancepools)** — Manage which users can manage or attach to pools. *
**[Repo permissions](repos)** — Manage which users can read, run, edit, or manage a repo. *
**[Serving endpoint permissions](:service:servingendpoints)** — Manage which users can view,
query, or manage a serving endpoint. * **[SQL warehouse permissions](:service:warehouses)** —
Manage which users can use or manage SQL warehouses. * **[Token
permissions](:service:tokenmanagement)** — Manage which users can create or use tokens. *
**[Workspace object permissions](:service:workspace)** — Manage which users can read, run, edit,
or manage alerts, dbsql-dashboards, directories, files, notebooks and queries.
|
class |
PermissionsDescription |
interface |
PermissionsService
Permissions API are used to create read, write, edit, update and manage access for various users
on different objects and endpoints. * **[Apps permissions](:service:apps)** — Manage which users
can manage or use apps. * **[Cluster permissions](:service:clusters)** — Manage which users can
manage, restart, or attach to clusters. * **[Cluster policy
permissions](:service:clusterpolicies)** — Manage which users can use cluster policies. *
**[Spark Declarative Pipelines permissions](:service:pipelines)** — Manage which users can view,
manage, run, cancel, or own a Spark Declarative Pipeline. * **[Job permissions](:service:jobs)**
— Manage which users can view, manage, trigger, cancel, or own a job. * **[MLflow experiment
permissions](:service:experiments)** — Manage which users can read, edit, or manage MLflow
experiments. * **[MLflow registered model permissions](:service:modelregistry)** — Manage which
users can read, edit, or manage MLflow registered models. * **[Instance Pool
permissions](:service:instancepools)** — Manage which users can manage or attach to pools. *
**[Repo permissions](repos)** — Manage which users can read, run, edit, or manage a repo. *
**[Serving endpoint permissions](:service:servingendpoints)** — Manage which users can view,
query, or manage a serving endpoint. * **[SQL warehouse permissions](:service:warehouses)** —
Manage which users can use or manage SQL warehouses. * **[Token
permissions](:service:tokenmanagement)** — Manage which users can create or use tokens. *
**[Workspace object permissions](:service:workspace)** — Manage which users can read, run, edit,
or manage alerts, dbsql-dashboards, directories, files, notebooks and queries.
|
class |
PrincipalOutput
Information about the principal assigned to the workspace.
|
class |
RequestAuthzIdentity
Defines the identity to be used for authZ of the request on the server side.
|
class |
ResourceInfo |
class |
ResourceMeta |
class |
Role |
class |
RuleSetResponse |
class |
RuleSetUpdateRequest |
class |
ServicePrincipal |
class |
ServicePrincipalsAPI
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
ServicePrincipalSchema |
interface |
ServicePrincipalsService
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
ServicePrincipalsV2API
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
interface |
ServicePrincipalsV2Service
Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD
platforms.
|
class |
SetObjectPermissions |
class |
UpdateAccountGroupRequest |
class |
UpdateAccountServicePrincipalRequest |
class |
UpdateAccountUserRequest |
class |
UpdateGroupRequest |
class |
UpdateObjectPermissions |
class |
UpdateRuleSetRequest |
class |
UpdateServicePrincipalRequest |
class |
UpdateUserRequest |
class |
UpdateWorkspaceAssignments |
class |
User |
class |
UsersAPI
User identities recognized by Databricks and represented by email addresses.
|
class |
UserSchema |
interface |
UsersService
User identities recognized by Databricks and represented by email addresses.
|
class |
UsersV2API
User identities recognized by Databricks and represented by email addresses.
|
interface |
UsersV2Service
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 |
AccountIamV2API
These APIs are used to manage identities and the workspace access of these identities in
|
interface |
AccountIamV2Service
These APIs are used to manage identities and the workspace access of these identities in
|
class |
CreateWorkspaceAssignmentDetailProxyRequest |
class |
CreateWorkspaceAssignmentDetailRequest |
class |
DeleteWorkspaceAssignmentDetailProxyRequest |
class |
DeleteWorkspaceAssignmentDetailRequest |
class |
Entitlement |
class |
GetWorkspaceAccessDetailLocalRequest |
class |
GetWorkspaceAccessDetailRequest |
class |
GetWorkspaceAssignmentDetailProxyRequest |
class |
GetWorkspaceAssignmentDetailRequest |
class |
Group
The details of a Group resource.
|
class |
ListWorkspaceAssignmentDetailsProxyRequest |
class |
ListWorkspaceAssignmentDetailsRequest |
class |
ListWorkspaceAssignmentDetailsResponse
Response message for listing workspace assignment details.
|
class |
PrincipalType
The type of the principal (user/sp/group).
|
class |
ResolveGroupProxyRequest
Request message for resolving a group with the given external ID from the customer's IdP into
Databricks.
|
class |
ResolveGroupRequest
Request message for resolving a group with the given external ID from the customer's IdP into
Databricks.
|
class |
ResolveGroupResponse |
class |
ResolveServicePrincipalProxyRequest
Request message for resolving a service principal with the given external ID from the customer's
IdP into Databricks.
|
class |
ResolveServicePrincipalRequest
Request message for resolving a service principal with the given external ID from the customer's
IdP into Databricks.
|
class |
ResolveServicePrincipalResponse |
class |
ResolveUserProxyRequest
Request message for resolving a user with the given external ID from the customer's IdP into
Databricks.
|
class |
ResolveUserRequest
Request message for resolving a user with the given external ID from the customer's IdP into
Databricks.
|
class |
ResolveUserResponse |
class |
ServicePrincipal
The details of a ServicePrincipal resource.
|
class |
State
The activity status of a user or service principal in a Databricks account or workspace.
|
class |
UpdateWorkspaceAssignmentDetailProxyRequest |
class |
UpdateWorkspaceAssignmentDetailRequest |
class |
User
The details of a User resource.
|
class |
UserName |
class |
WorkspaceAccessDetail
The details of a principal's access to a workspace.
|
class |
WorkspaceAccessDetailAccessType
The type of access the principal has to the workspace.
|
class |
WorkspaceAccessDetailView
Controls what fields are returned in the GetWorkspaceAccessDetail response.
|
class |
WorkspaceAssignmentDetail
The details of a principal's assignment to a workspace.
|
class |
WorkspaceIamV2API
These APIs are used to manage identities and the workspace access of these identities in
|
interface |
WorkspaceIamV2Service
These APIs are used to manage identities and the workspace access of these identities in
|
class |
WorkspacePermission
The type of permission a principal has to a workspace (admin/user).
|
| Modifier and Type | Class and Description |
|---|---|
class |
AlertEvaluationState
Same alert evaluation state as in redash-v2/api/proto/alertsv2/alerts.proto
|
class |
AlertTask |
class |
AlertTaskOutput |
class |
AlertTaskSubscriber
Represents a subscriber that will receive alert notifications.
|
class |
AuthenticationMethod |
class |
BaseJob |
class |
BaseRun |
class |
CancelAllRuns |
class |
CancelRun |
class |
CleanRoomsNotebookTask
Clean Rooms notebook task for V1 Clean Room service (GA).
|
class |
CleanRoomsNotebookTaskCleanRoomsNotebookTaskOutput |
class |
CleanRoomTaskRunLifeCycleState
Copied from elastic-spark-common/api/messages/runs.proto.
|
class |
CleanRoomTaskRunResultState
Copied from elastic-spark-common/api/messages/runs.proto.
|
class |
CleanRoomTaskRunState
Stores the run state of the clean rooms notebook task.
|
class |
ClusterInstance |
class |
ClusterSpec |
class |
Compute |
class |
ComputeConfig |
class |
Condition |
class |
ConditionTask |
class |
ConditionTaskOp
* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands.
|
class |
Continuous |
class |
CreateJob |
class |
CreateResponse
Job was created successfully
|
class |
CronSchedule |
class |
DashboardPageSnapshot |
class |
DashboardTask
Configures the Lakeview Dashboard job task type.
|
class |
DashboardTaskOutput |
class |
DbtCloudJobRunStep
Format of response retrieved from dbt Cloud, for inclusion in output Deprecated in favor of
DbtPlatformJobRunStep
|
class |
DbtCloudTask
Deprecated in favor of DbtPlatformTask
|
class |
DbtCloudTaskOutput
Deprecated in favor of DbtPlatformTaskOutput
|
class |
DbtOutput |
class |
DbtPlatformJobRunStep
Format of response retrieved from dbt platform, for inclusion in output
|
class |
DbtPlatformRunStatus
Response enumeration from calling the dbt platform API, for inclusion in output
|
class |
DbtPlatformTask |
class |
DbtPlatformTaskOutput |
class |
DbtTask |
class |
DeleteJob |
class |
DeleteRun |
class |
EnforcePolicyComplianceForJobResponseJobClusterSettingsChange
Represents a change to the job cluster's settings that would be required for the job clusters to
become compliant with their policies.
|
class |
EnforcePolicyComplianceRequest |
class |
EnforcePolicyComplianceResponse |
class |
ExportRunOutput
Run was exported successfully.
|
class |
ExportRunRequest |
class |
FileArrivalTriggerConfiguration |
class |
FileArrivalTriggerState |
class |
ForEachStats |
class |
ForEachTask |
class |
ForEachTaskErrorMessageStats |
class |
ForEachTaskTaskRunStats |
class |
Format |
class |
GenAiComputeTask |
class |
GetJobPermissionLevelsRequest |
class |
GetJobPermissionLevelsResponse |
class |
GetJobPermissionsRequest |
class |
GetJobRequest |
class |
GetPolicyComplianceRequest |
class |
GetPolicyComplianceResponse |
class |
GetRunOutputRequest |
class |
GetRunRequest |
class |
GitProvider |
class |
GitSnapshot
Read-only state of the remote repository at the time the job was run.
|
class |
GitSource
An optional specification for a remote Git repository containing the source code used by tasks.
|
class |
Job
Job was retrieved successfully.
|
class |
JobAccessControlRequest |
class |
JobAccessControlResponse |
class |
JobCluster |
class |
JobCompliance |
class |
JobDeployment |
class |
JobDeploymentKind
* `BUNDLE`: The job is managed by Databricks Asset Bundle. * `SYSTEM_MANAGED`: The job is managed
by Databricks and is read-only.
|
class |
JobEditMode
Edit mode of the job.
|
class |
JobEmailNotifications |
class |
JobEnvironment |
class |
JobNotificationSettings |
class |
JobParameter |
class |
JobParameterDefinition |
class |
JobPermission |
class |
JobPermissionLevel
Permission level
|
class |
JobPermissions |
class |
JobPermissionsDescription |
class |
JobPermissionsRequest |
class |
JobRunAs
Write-only setting.
|
class |
JobsAPI
The Jobs API allows you to create, edit, and delete jobs.
|
class |
JobSettings |
class |
JobsHealthMetric
Specifies the health metric that is being evaluated for a particular health rule.
|
class |
JobsHealthOperator
Specifies the operator used to compare the health metric value with the specified threshold.
|
class |
JobsHealthRule |
class |
JobsHealthRules
An optional set of health rules that can be defined for this job.
|
class |
JobSource
The source of the job specification in the remote repository when the job is source controlled.
|
class |
JobSourceDirtyState
Dirty state indicates the job is not fully synced with the job specification in the remote
repository.
|
interface |
JobsService
The Jobs API allows you to create, edit, and delete jobs.
|
class |
ListJobComplianceForPolicyResponse |
class |
ListJobComplianceRequest |
class |
ListJobsRequest |
class |
ListJobsResponse
List of jobs was retrieved successfully.
|
class |
ListRunsRequest |
class |
ListRunsResponse
List of runs was retrieved successfully.
|
class |
ModelTriggerConfiguration |
class |
ModelTriggerConfigurationCondition |
class |
NotebookOutput |
class |
NotebookTask |
class |
OutputSchemaInfo
Stores the catalog name, schema name, and the output schema expiration time for the clean room
run.
|
class |
PauseStatus |
class |
PerformanceTarget
PerformanceTarget defines how performant (lower latency) or cost efficient the execution of run
on serverless compute should be.
|
class |
PeriodicTriggerConfiguration |
class |
PeriodicTriggerConfigurationTimeUnit |
class |
PipelineParams |
class |
PipelineTask |
class |
PolicyComplianceForJobsAPI
The compliance APIs allow you to view and manage the policy compliance status of jobs in your
workspace.
|
interface |
PolicyComplianceForJobsService
The compliance APIs allow you to view and manage the policy compliance status of jobs in your
workspace.
|
class |
PowerBiModel |
class |
PowerBiTable |
class |
PowerBiTask |
class |
PythonOperatorTask |
class |
PythonOperatorTaskParameter |
class |
PythonWheelTask |
class |
QueueDetails |
class |
QueueDetailsCodeCode
The reason for queuing the run. * `ACTIVE_RUNS_LIMIT_REACHED`: The run was queued due to reaching
the workspace limit of active task runs. * `MAX_CONCURRENT_RUNS_REACHED`: The run was queued due
to reaching the per-job limit of concurrent job runs. * `ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED`: The
run was queued due to reaching the workspace limit of active run job tasks.
|
class |
QueueSettings |
class |
RepairHistoryItem |
class |
RepairHistoryItemType
The repair history item type.
|
class |
RepairRun |
class |
RepairRunResponse
Run repair was initiated.
|
class |
ResetJob |
class |
ResolvedConditionTaskValues |
class |
ResolvedDbtTaskValues |
class |
ResolvedNotebookTaskValues |
class |
ResolvedParamPairValues |
class |
ResolvedPythonWheelTaskValues |
class |
ResolvedRunJobTaskValues |
class |
ResolvedStringParamsValues |
class |
ResolvedValues |
class |
Run
Run was retrieved successfully
|
class |
RunConditionTask |
class |
RunForEachTask |
class |
RunIf
An optional value indicating the condition that determines whether the task should be run once
its dependencies have been completed.
|
class |
RunJobOutput |
class |
RunJobTask |
class |
RunLifeCycleState
A value indicating the run's lifecycle state.
|
class |
RunLifecycleStateV2State
The current state of the run.
|
class |
RunNow |
class |
RunNowResponse
Run was started successfully.
|
class |
RunOutput
Run output was retrieved successfully.
|
class |
RunParameters |
class |
RunResultState
A value indicating the run's result.
|
class |
RunState
The current state of the run.
|
class |
RunStatus
The current status of the run
|
class |
RunTask
Used when outputting a child run, in GetRun or ListRuns.
|
class |
RunType
The type of a run. * `JOB_RUN`: Normal job run.
|
class |
Source
Optional location type of the SQL file.
|
class |
SparkJarTask |
class |
SparkPythonTask |
class |
SparkSubmitTask |
class |
SparseCheckout |
class |
SqlAlertOutput |
class |
SqlAlertState
The state of the SQL alert.
|
class |
SqlDashboardOutput |
class |
SqlDashboardWidgetOutput |
class |
SqlDashboardWidgetOutputStatus |
class |
SqlOutput |
class |
SqlOutputError |
class |
SqlQueryOutput |
class |
SqlStatementOutput |
class |
SqlTask |
class |
SqlTaskAlert |
class |
SqlTaskDashboard |
class |
SqlTaskFile |
class |
SqlTaskQuery |
class |
SqlTaskSubscription |
class |
StorageMode |
class |
SubmitRun |
class |
SubmitRunResponse
Run was created and started successfully.
|
class |
SubmitTask |
class |
Subscription |
class |
SubscriptionSubscriber |
class |
TableState |
class |
TableTriggerState |
class |
TableUpdateTriggerConfiguration |
class |
Task |
class |
TaskDependency |
class |
TaskEmailNotifications |
class |
TaskNotificationSettings |
class |
TaskRetryMode
task retry mode of the continuous job * NEVER: The failed task will not be retried. * ON_FAILURE:
Retry a failed task if at least one other task in the job is still running its first attempt.
|
class |
TerminationCodeCode
The code indicates why the run was terminated.
|
class |
TerminationDetails |
class |
TerminationTypeType
* `SUCCESS`: The run terminated without any issues * `INTERNAL_ERROR`: An error occurred in the
Databricks platform.
|
class |
TriggerInfo
Additional details about what triggered the run
|
class |
TriggerSettings |
class |
TriggerStateProto |
class |
TriggerType
The type of trigger that fired this run.
|
class |
UpdateJob |
class |
ViewItem |
class |
ViewsToExport
* `CODE`: Code view of the notebook. * `DASHBOARDS`: All dashboard views of the notebook. *
`ALL`: All views of the notebook.
|
class |
ViewType
`NOTEBOOK`: Notebook view item. * `DASHBOARD`: Dashboard view item.
|
class |
Webhook |
class |
WebhookNotifications |
class |
WidgetErrorDetail |
| Modifier and Type | Class and Description |
|---|---|
class |
Activity
For activities, this contains the activity recorded for the action.
|
class |
ActivityAction
An action that a user (with sufficient permissions) could take on an activity or comment.
|
class |
ActivityType
Type of activity.
|
class |
AggregationFunction
An aggregation function applied over a time window.
|
class |
ApproveTransitionRequest
Details required to identify and approve a model version stage transition request.
|
class |
ApproveTransitionRequestResponse |
class |
ApproxCountDistinctFunction
Computes the approximate count of distinct values.
|
class |
ApproxPercentileFunction
Computes the approximate percentile of values.
|
class |
AuthConfig |
class |
AvgFunction
Computes the average of values.
|
class |
BackfillSource |
class |
BatchCreateMaterializedFeaturesRequest |
class |
BatchCreateMaterializedFeaturesResponse |
class |
ColumnIdentifier |
class |
ColumnSelection
A ColumnSelection function, equivalent to the LAST() record of an entity over a lifetime
ContinuousWindow
|
class |
CommentActivityAction
An action that a user (with sufficient permissions) could take on an activity or comment.
|
class |
CommentObject
For activities, this contains the activity recorded for the action.
|
class |
ContinuousWindow
Deprecated: use RollingWindow with `delay` instead.
|
class |
CountFunction
Computes the count of values.
|
class |
CreateComment
Details required to create a comment on a model version.
|
class |
CreateCommentResponse |
class |
CreateExperiment |
class |
CreateExperimentResponse |
class |
CreateFeatureRequest |
class |
CreateFeatureTagRequest |
class |
CreateForecastingExperimentRequest |
class |
CreateForecastingExperimentResponse |
class |
CreateKafkaConfigRequest |
class |
CreateLoggedModelRequest |
class |
CreateLoggedModelResponse |
class |
CreateMaterializedFeatureRequest |
class |
CreateModelRequest |
class |
CreateModelResponse |
class |
CreateModelVersionRequest |
class |
CreateModelVersionResponse |
class |
CreateOnlineStoreRequest |
class |
CreateRegistryWebhook
Details required to create a registry webhook.
|
class |
CreateRun |
class |
CreateRunResponse |
class |
CreateTransitionRequest
Details required to create a model version stage transition request.
|
class |
CreateTransitionRequestResponse |
class |
CreateWebhookResponse |
class |
Dataset
Dataset.
|
class |
DatasetInput
DatasetInput.
|
class |
DataSource
Specifies the data source backing a feature.
|
class |
DeleteCommentRequest |
class |
DeleteExperiment |
class |
DeleteFeatureRequest |
class |
DeleteFeatureTagRequest |
class |
DeleteKafkaConfigRequest |
class |
DeleteLoggedModelRequest |
class |
DeleteLoggedModelTagRequest |
class |
DeleteMaterializedFeatureRequest |
class |
DeleteModelRequest |
class |
DeleteModelTagRequest |
class |
DeleteModelVersionRequest |
class |
DeleteModelVersionTagRequest |
class |
DeleteOnlineStoreRequest |
class |
DeleteOnlineTableRequest |
class |
DeleteRun |
class |
DeleteRuns |
class |
DeleteRunsResponse |
class |
DeleteTag |
class |
DeleteTransitionRequestRequest |
class |
DeleteTransitionRequestResponse |
class |
DeleteWebhookRequest |
class |
DeltaTableSource |
class |
EntityColumn |
class |
Experiment
An experiment and its metadata.
|
class |
ExperimentAccessControlRequest |
class |
ExperimentAccessControlResponse |
class |
ExperimentPermission |
class |
ExperimentPermissionLevel
Permission level
|
class |
ExperimentPermissions |
class |
ExperimentPermissionsDescription |
class |
ExperimentPermissionsRequest |
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
A tag for an experiment.
|
class |
Feature |
class |
FeatureEngineeringAPI
[description]
|
interface |
FeatureEngineeringService
[description]
This is the high-level interface, that contains generated methods.
|
class |
FeatureLineage |
class |
FeatureLineageFeatureSpec |
class |
FeatureLineageModel |
class |
FeatureLineageOnlineFeature |
class |
FeatureList
Feature list wrap all the features for a model version
|
class |
FeatureStoreAPI
A feature store is a centralized repository that enables data scientists to find and share
features.
|
interface |
FeatureStoreService
A feature store is a centralized repository that enables data scientists to find and share
features.
|
class |
FeatureTag
Represents a tag on a feature in a feature table.
|
class |
FieldDefinition
A single field definition within a FlatSchema, specifying the field name and its scalar data
type.
|
class |
FileInfo
Metadata of a single artifact file or directory.
|
class |
FinalizeLoggedModelRequest |
class |
FinalizeLoggedModelResponse |
class |
FirstFunction
Returns the first value.
|
class |
FlatSchema
A flat (non-nested) schema for request-time fields, defined as an ordered list of field
definitions.
|
class |
ForecastingAPI
The Forecasting API allows you to create and get serverless forecasting experiments
|
class |
ForecastingExperiment
Represents a forecasting experiment with its unique identifier, URL, and state.
|
class |
ForecastingExperimentState |
interface |
ForecastingService
The Forecasting API allows you to create and get serverless forecasting experiments
This is the high-level interface, that contains generated methods.
|
class |
Function |
class |
FunctionExtraParameter
Deprecated: Use typed fields on function-specific messages (e.g.
|
class |
FunctionFunctionType
Deprecated: Use the function-specific messages in AggregationFunction.function_type oneof
instead.
|
class |
GetByNameRequest |
class |
GetExperimentByNameResponse |
class |
GetExperimentPermissionLevelsRequest |
class |
GetExperimentPermissionLevelsResponse |
class |
GetExperimentPermissionsRequest |
class |
GetExperimentRequest |
class |
GetExperimentResponse |
class |
GetFeatureLineageRequest |
class |
GetFeatureRequest |
class |
GetFeatureTagRequest |
class |
GetForecastingExperimentRequest |
class |
GetHistoryRequest |
class |
GetKafkaConfigRequest |
class |
GetLatestVersionsRequest |
class |
GetLatestVersionsResponse |
class |
GetLoggedModelRequest |
class |
GetLoggedModelResponse |
class |
GetMaterializedFeatureRequest |
class |
GetMetricHistoryResponse |
class |
GetModelRequest |
class |
GetModelResponse |
class |
GetModelVersionDownloadUriRequest |
class |
GetModelVersionDownloadUriResponse |
class |
GetModelVersionRequest |
class |
GetModelVersionResponse |
class |
GetOnlineStoreRequest |
class |
GetRegisteredModelPermissionLevelsRequest |
class |
GetRegisteredModelPermissionLevelsResponse |
class |
GetRegisteredModelPermissionsRequest |
class |
GetRunRequest |
class |
GetRunResponse |
class |
HttpUrlSpec |
class |
HttpUrlSpecWithoutSecret |
class |
InputTag
Tag for a dataset input.
|
class |
JobContext |
class |
JobSpec |
class |
JobSpecWithoutSecret |
class |
KafkaConfig |
class |
KafkaSource |
class |
LastFunction
Returns the last value.
|
class |
LineageContext
Lineage context information for tracking where an API was invoked.
|
class |
LinkedFeature
Feature for model version.
|
class |
ListArtifactsRequest |
class |
ListArtifactsResponse |
class |
ListExperimentsRequest |
class |
ListExperimentsResponse |
class |
ListFeaturesRequest |
class |
ListFeaturesResponse |
class |
ListFeatureTagsRequest |
class |
ListFeatureTagsResponse
Response message for ListFeatureTag.
|
class |
ListKafkaConfigsRequest |
class |
ListKafkaConfigsResponse |
class |
ListMaterializedFeaturesRequest |
class |
ListMaterializedFeaturesResponse |
class |
ListModelsRequest |
class |
ListModelsResponse |
class |
ListOnlineStoresRequest |
class |
ListOnlineStoresResponse |
class |
ListRegistryWebhooks |
class |
ListTransitionRequestsRequest |
class |
ListTransitionRequestsResponse |
class |
ListWebhooksRequest |
class |
LogBatch |
class |
LoggedModel
A logged model message includes logged model attributes, tags, registration info, params, and
linked run metrics.
|
class |
LoggedModelData
A LoggedModelData message includes logged model params and linked metrics.
|
class |
LoggedModelInfo
A LoggedModelInfo includes logged model attributes, tags, and registration info.
|
class |
LoggedModelParameter
Parameter associated with a LoggedModel.
|
class |
LoggedModelStatus
A LoggedModelStatus enum value represents the status of a logged model.
|
class |
LoggedModelTag
Tag for a LoggedModel.
|
class |
LogInputs |
class |
LogLoggedModelParamsRequest |
class |
LogMetric |
class |
LogModel |
class |
LogOutputsRequest |
class |
LogParam |
class |
MaterializedFeature
A materialized feature represents a feature that is continuously computed and stored.
|
class |
MaterializedFeaturePipelineScheduleState |
class |
MaterializedFeaturesAPI
Materialized Features are columns in tables and views that can be directly used as features to
train and serve ML models.
|
interface |
MaterializedFeaturesService
Materialized Features are columns in tables and views that can be directly used as features to
train and serve ML models.
|
class |
MaxFunction
Computes the maximum value.
|
class |
Metric
Metric associated with a run, represented as a key-value pair.
|
class |
MinFunction
Computes the minimum value.
|
class |
Model |
class |
ModelDatabricks |
class |
ModelInput
Represents a LoggedModel or Registered Model Version input to a Run.
|
class |
ModelOutput
Represents a LoggedModel output of a Run.
|
class |
ModelRegistryAPI
Note: This API reference documents APIs for the Workspace Model Registry.
|
interface |
ModelRegistryService
Note: This API reference documents APIs for the Workspace Model Registry.
|
class |
ModelTag
Tag for a registered model
|
class |
ModelVersion |
class |
ModelVersionDatabricks |
class |
ModelVersionStatus
The status of the model version.
|
class |
ModelVersionTag |
class |
MtlsConfig
Mutual-TLS (mTLS) authentication configuration.
|
class |
OfflineStoreConfig
Configuration for offline store destination.
|
class |
OnlineStore
An OnlineStore is a logical database instance that stores and serves features online.
|
class |
OnlineStoreConfig
Configuration for online store destination.
|
class |
OnlineStoreState |
class |
Param
Param associated with a run.
|
class |
PermissionLevel
Permission level of the requesting user on the object.
|
class |
PublishSpec |
class |
PublishSpecPublishMode |
class |
PublishTableRequest |
class |
PublishTableResponse |
class |
RegisteredModelAccessControlRequest |
class |
RegisteredModelAccessControlResponse |
class |
RegisteredModelPermission |
class |
RegisteredModelPermissionLevel
Permission level
|
class |
RegisteredModelPermissions |
class |
RegisteredModelPermissionsDescription |
class |
RegisteredModelPermissionsRequest |
class |
RegistryEmailSubscriptionType
.. note:: Experimental: This entity may change or be removed in a future release without warning.
|
class |
RegistryWebhook |
class |
RegistryWebhookEvent |
class |
RegistryWebhookStatus
Enable or disable triggering the webhook, or put the webhook into test mode.
|
class |
RejectTransitionRequest
Details required to identify and reject a model version stage transition request.
|
class |
RejectTransitionRequestResponse |
class |
RenameModelRequest |
class |
RenameModelResponse |
class |
RequestSource
A request-time data source whose value is provided at inference time: offline batch scoring or
online serving endpoint
|
class |
RestoreExperiment |
class |
RestoreRun |
class |
RestoreRuns |
class |
RestoreRunsResponse |
class |
RollingWindow
A rolling time window with an optional delay.
|
class |
Run
A single run.
|
class |
RunData
Run data (metrics, params, and tags).
|
class |
RunInfo
Metadata of a single run.
|
class |
RunInfoStatus
Status of a run.
|
class |
RunInputs
Run inputs.
|
class |
RunTag
Tag for a run.
|
class |
ScalarDataType
Scalar data types for request-time field definitions.
|
class |
SchemaConfig |
class |
SearchExperiments |
class |
SearchExperimentsResponse |
class |
SearchLoggedModelsDataset |
class |
SearchLoggedModelsOrderBy |
class |
SearchLoggedModelsRequest |
class |
SearchLoggedModelsResponse |
class |
SearchModelsRequest |
class |
SearchModelsResponse |
class |
SearchModelVersionsRequest |
class |
SearchModelVersionsResponse |
class |
SearchRuns |
class |
SearchRunsResponse |
class |
SecretScopeReference
Reference to an entry in a Databricks secret scope.
|
class |
SetExperimentTag |
class |
SetLoggedModelTagsRequest |
class |
SetModelTagRequest |
class |
SetModelVersionTagRequest |
class |
SetTag |
class |
SlidingWindow |
class |
Status
The status of the model version.
|
class |
StddevPopFunction
Computes the population standard deviation.
|
class |
StddevSampFunction
Computes the sample standard deviation.
|
class |
SubscriptionMode
Deprecated: Use KafkaSubscriptionMode instead.
|
class |
SumFunction
Computes the sum of values.
|
class |
TestRegistryWebhookRequest
Details required to test a registry webhook.
|
class |
TestRegistryWebhookResponse |
class |
TimeseriesColumn |
class |
TimeWindow |
class |
TransitionModelVersionStageDatabricks
Details required to transition a model version's stage.
|
class |
TransitionRequest
For activities, this contains the activity recorded for the action.
|
class |
TransitionStageResponse |
class |
TumblingWindow |
class |
UpdateComment
Details required to edit a comment on a model version.
|
class |
UpdateCommentResponse |
class |
UpdateExperiment |
class |
UpdateFeatureRequest |
class |
UpdateFeatureTagRequest |
class |
UpdateKafkaConfigRequest |
class |
UpdateMaterializedFeatureRequest |
class |
UpdateModelRequest |
class |
UpdateModelResponse |
class |
UpdateModelVersionRequest |
class |
UpdateModelVersionResponse |
class |
UpdateOnlineStoreRequest |
class |
UpdateRegistryWebhook
Details required to update a registry webhook.
|
class |
UpdateRun |
class |
UpdateRunResponse |
class |
UpdateRunStatus
Status of a run.
|
class |
UpdateWebhookResponse |
class |
VarPopFunction
Computes the population variance.
|
class |
VarSampFunction
Computes the sample variance.
|
class |
ViewType
Qualifier for the view type.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AzurePrivateEndpointInfo |
class |
CreateEndpointRequest |
class |
DeleteEndpointRequest |
class |
Endpoint
Endpoint represents a cloud networking resource in a user's cloud account and binds it to the
Databricks account.
|
class |
EndpointsAPI
These APIs manage endpoint configurations for this account.
|
interface |
EndpointsService
These APIs manage endpoint configurations for this account.
|
class |
EndpointState |
class |
EndpointUseCase |
class |
GetEndpointRequest |
class |
ListEndpointsRequest |
class |
ListEndpointsResponse |
| Modifier and Type | Class and Description |
|---|---|
class |
AccountFederationPolicyAPI
These APIs manage account federation policies.
|
interface |
AccountFederationPolicyService
These APIs manage account federation policies.
|
class |
CreateAccountFederationPolicyRequest |
class |
CreateCustomAppIntegration |
class |
CreateCustomAppIntegrationOutput |
class |
CreatePublishedAppIntegration |
class |
CreatePublishedAppIntegrationOutput |
class |
CreateServicePrincipalFederationPolicyRequest |
class |
CreateServicePrincipalSecretRequest |
class |
CreateServicePrincipalSecretResponse |
class |
CustomAppIntegrationAPI
These APIs enable administrators to manage custom OAuth app integrations, which is required for
adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.
|
interface |
CustomAppIntegrationService
These APIs enable administrators to manage custom OAuth app integrations, which is required for
adding/using Custom OAuth App Integration like Tableau Cloud for Databricks in AWS cloud.
|
class |
DeleteAccountFederationPolicyRequest |
class |
DeleteCustomAppIntegrationRequest |
class |
DeletePublishedAppIntegrationRequest |
class |
DeleteServicePrincipalFederationPolicyRequest |
class |
DeleteServicePrincipalSecretRequest |
class |
FederationPolicy |
class |
GetAccountFederationPolicyRequest |
class |
GetCustomAppIntegrationOutput |
class |
GetCustomAppIntegrationRequest |
class |
GetCustomAppIntegrationsOutput |
class |
GetPublishedAppIntegrationOutput |
class |
GetPublishedAppIntegrationRequest |
class |
GetPublishedAppIntegrationsOutput |
class |
GetPublishedAppsOutput |
class |
GetServicePrincipalFederationPolicyRequest |
class |
ListAccountFederationPoliciesRequest |
class |
ListCustomAppIntegrationsRequest |
class |
ListFederationPoliciesResponse |
class |
ListOAuthPublishedAppsRequest |
class |
ListPublishedAppIntegrationsRequest |
class |
ListServicePrincipalFederationPoliciesRequest |
class |
ListServicePrincipalSecretsRequest |
class |
ListServicePrincipalSecretsResponse |
class |
OAuthPublishedAppsAPI
These APIs enable administrators to view all the available published OAuth applications in
Databricks.
|
interface |
OAuthPublishedAppsService
These APIs enable administrators to view all the available published OAuth applications in
Databricks.
|
class |
OidcFederationPolicy
Specifies the policy to use for validating OIDC claims in your federated tokens.
|
class |
PublishedAppIntegrationAPI
These APIs enable administrators to manage published OAuth app integrations, which is required
for adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS
cloud.
|
interface |
PublishedAppIntegrationService
These APIs enable administrators to manage published OAuth app integrations, which is required
for adding/using Published OAuth App Integration like Tableau Desktop for Databricks in AWS
cloud.
|
class |
PublishedAppOutput |
class |
SecretInfo |
class |
ServicePrincipalFederationPolicyAPI
These APIs manage service principal federation policies.
|
interface |
ServicePrincipalFederationPolicyService
These APIs manage service principal federation policies.
|
class |
ServicePrincipalSecretsAPI
These APIs enable administrators to manage service principal secrets.
|
class |
ServicePrincipalSecretsProxyAPI
These APIs enable administrators to manage service principal secrets at the workspace level.
|
interface |
ServicePrincipalSecretsProxyService
These APIs enable administrators to manage service principal secrets at the workspace level.
|
interface |
ServicePrincipalSecretsService
These APIs enable administrators to manage service principal secrets.
|
class |
TokenAccessPolicy |
class |
UpdateAccountFederationPolicyRequest |
class |
UpdateCustomAppIntegration |
class |
UpdatePublishedAppIntegration |
class |
UpdateServicePrincipalFederationPolicyRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
ApplyEnvironmentRequest |
class |
ApplyEnvironmentRequestResponse |
class |
AutoFullRefreshPolicy
Policy for auto full refresh.
|
class |
CloneMode
Enum to specify which mode of clone to execute
|
class |
ClonePipelineRequest |
class |
ClonePipelineResponse |
class |
ConfluenceConnectorOptions
Confluence specific options for ingestion
|
class |
ConnectionParameters |
class |
ConnectorOptions
Wrapper message for source-specific options to support multiple connector types
|
class |
ConnectorType
For certain database sources LakeFlow Connect offers both query based and cdc ingestion,
ConnectorType can bse used to convey the type of ingestion.
|
class |
CreatePipeline |
class |
CreatePipelineResponse |
class |
CronTrigger |
class |
DataPlaneId |
class |
DataStagingOptions
Location of staged data storage
|
class |
DayOfWeek
Days of week in which the window is allowed to happen.
|
class |
DeletePipelineRequest |
class |
DeploymentKind
The deployment method that manages the pipeline: - BUNDLE: The pipeline is managed by a
Databricks Asset Bundle.
|
class |
EditPipeline |
class |
ErrorDetail |
class |
EventLevel
The severity level of the event.
|
class |
EventLogSpec
Configurable event log parameters.
|
class |
FileFilter |
class |
FileIngestionOptions |
class |
FileIngestionOptionsFileFormat |
class |
FileIngestionOptionsSchemaEvolutionMode
Based on
https://docs.databricks.com/aws/en/ingestion/cloud-object-storage/auto-loader/schema#how-does-auto-loader-schema-evolution-work
|
class |
FileLibrary |
class |
Filters |
class |
GetPipelinePermissionLevelsRequest |
class |
GetPipelinePermissionLevelsResponse |
class |
GetPipelinePermissionsRequest |
class |
GetPipelineRequest |
class |
GetPipelineResponse |
class |
GetPipelineResponseHealth
The health of a pipeline.
|
class |
GetUpdateRequest |
class |
GetUpdateResponse |
class |
GoogleAdsConfig |
class |
GoogleAdsOptions
Google Ads specific options for ingestion (object-level).
|
class |
GoogleDriveOptions |
class |
GoogleDriveOptionsGoogleDriveEntityType |
class |
IngestionConfig |
class |
IngestionGatewayPipelineDefinition |
class |
IngestionPipelineDefinition |
class |
IngestionPipelineDefinitionTableSpecificConfigQueryBasedConnectorConfig
Configurations that are only applicable for query-based ingestion connectors.
|
class |
IngestionPipelineDefinitionWorkdayReportParameters |
class |
IngestionPipelineDefinitionWorkdayReportParametersQueryKeyValue |
class |
IngestionSourceType |
class |
JiraConnectorOptions
Jira specific options for ingestion
|
class |
JsonTransformerOptions |
class |
KafkaOptions |
class |
ListPipelineEventsRequest |
class |
ListPipelineEventsResponse |
class |
ListPipelinesRequest |
class |
ListPipelinesResponse |
class |
ListUpdatesRequest |
class |
ListUpdatesResponse |
class |
ManualTrigger |
class |
MaturityLevel
Maturity level for EventDetails.
|
class |
MetaMarketingOptions
Meta Marketing (Meta Ads) specific options for ingestion
|
class |
NotebookLibrary |
class |
Notifications |
class |
OperationTimeWindow
Proto representing a window
|
class |
Origin |
class |
OutlookAttachmentMode
Attachment behavior mode for Outlook ingestion
|
class |
OutlookBodyFormat
Body format for Outlook email content
|
class |
OutlookOptions
Outlook specific options for ingestion
|
class |
PathPattern |
class |
PipelineAccessControlRequest |
class |
PipelineAccessControlResponse |
class |
PipelineCluster |
class |
PipelineClusterAutoscale |
class |
PipelineClusterAutoscaleMode
Databricks Enhanced Autoscaling optimizes cluster utilization by automatically allocating cluster
resources based on workload volume, with minimal impact to the data processing latency of your
pipelines.
|
class |
PipelineDeployment |
class |
PipelineEvent |
class |
PipelineLibrary |
class |
PipelinePermission |
class |
PipelinePermissionLevel
Permission level
|
class |
PipelinePermissions |
class |
PipelinePermissionsDescription |
class |
PipelinePermissionsRequest |
class |
PipelinesAPI
The Lakeflow Spark Declarative Pipelines API allows you to create, edit, delete, start, and view
details about pipelines.
|
class |
PipelinesEnvironment
The environment entity used to preserve serverless environment side panel, jobs' environment for
non-notebook task, and SDP's environment for classic and serverless pipelines.
|
class |
PipelineSpec |
interface |
PipelinesService
The Lakeflow Spark Declarative Pipelines API allows you to create, edit, delete, start, and view
details about pipelines.
|
class |
PipelineState
The pipeline state.
|
class |
PipelineStateInfo |
class |
PipelineStateInfoHealth
The health of a pipeline.
|
class |
PipelineTrigger |
class |
PostgresCatalogConfig
PG-specific catalog-level configuration parameters
|
class |
PostgresSlotConfig
PostgresSlotConfig contains the configuration for a Postgres logical replication slot
|
class |
PublishingMode
Enum representing the publishing mode of a pipeline.
|
class |
ReplaceWhereOverride
Specifies a replace_where predicate override for a replace where flow.
|
class |
ReportSpec |
class |
RestartWindow |
class |
RewindDatasetSpec
Configuration for rewinding a specific dataset.
|
class |
RewindSpec
Information about a rewind being requested for this pipeline or some of the datasets in it.
|
class |
RunAs
Write-only setting, available only in Create/Update calls.
|
class |
SchemaSpec |
class |
Sequencing |
class |
SerializedException |
class |
SharepointOptions |
class |
SharepointOptionsSharepointEntityType |
class |
SmartsheetOptions
Smartsheet specific options for ingestion
|
class |
SourceCatalogConfig
SourceCatalogConfig contains catalog-level custom configuration parameters for each source
|
class |
SourceConfig |
class |
StackFrame |
class |
StartUpdate |
class |
StartUpdateCause
What triggered this update.
|
class |
StartUpdateResponse |
class |
StopRequest |
class |
TableSpec |
class |
TableSpecificConfig |
class |
TableSpecificConfigScdType
The SCD type to use to ingest the table.
|
class |
TikTokAdsOptions
TikTok Ads specific options for ingestion
|
class |
TikTokAdsOptionsTikTokDataLevel
Data level for TikTok Ads report aggregation.
|
class |
TikTokAdsOptionsTikTokReportType
Report type for TikTok Ads API.
|
class |
Transformer
Specifies how to transform binary data into structured data.
|
class |
TransformerFormat |
class |
Truncation
Information about truncations applied to this event.
|
class |
TruncationTruncationDetail
Details about a specific field that was truncated.
|
class |
UpdateInfo |
class |
UpdateInfoCause
What triggered this update.
|
class |
UpdateInfoState
The update state.
|
class |
UpdateStateInfo |
class |
UpdateStateInfoState
The update state.
|
class |
ZendeskSupportOptions
Zendesk Support specific options for ingestion
|
| Modifier and Type | Class and Description |
|---|---|
class |
Branch |
class |
BranchOperationMetadata |
class |
BranchSpec |
class |
BranchStatus |
class |
BranchStatusState
The state of the branch.
|
class |
Catalog |
class |
CatalogCatalogSpec
The desired state of the Catalog.
|
class |
CatalogCatalogStatus
The observed state of the Catalog.
|
class |
CatalogOperationMetadata |
class |
CreateBranchOperation
Wrapper for interacting with a long-running createBranch operation.
|
class |
CreateBranchRequest |
class |
CreateCatalogOperation
Wrapper for interacting with a long-running createCatalog operation.
|
class |
CreateCatalogRequest |
class |
CreateDatabaseOperation
Wrapper for interacting with a long-running createDatabase operation.
|
class |
CreateDatabaseRequest |
class |
CreateEndpointOperation
Wrapper for interacting with a long-running createEndpoint operation.
|
class |
CreateEndpointRequest |
class |
CreateProjectOperation
Wrapper for interacting with a long-running createProject operation.
|
class |
CreateProjectRequest |
class |
CreateRoleOperation
Wrapper for interacting with a long-running createRole operation.
|
class |
CreateRoleRequest |
class |
CreateSyncedTableOperation
Wrapper for interacting with a long-running createSyncedTable operation.
|
class |
CreateSyncedTableRequest |
class |
Database
Database represents a Postgres database within a Branch.
|
class |
DatabaseCredential |
class |
DatabaseDatabaseSpec |
class |
DatabaseDatabaseStatus |
class |
DatabaseOperationMetadata |
class |
DatabricksServiceExceptionWithDetailsProto
Databricks Error that is returned by all Databricks APIs.
|
class |
DeleteBranchOperation
Wrapper for interacting with a long-running deleteBranch operation.
|
class |
DeleteBranchRequest |
class |
DeleteCatalogOperation
Wrapper for interacting with a long-running deleteCatalog operation.
|
class |
DeleteCatalogRequest |
class |
DeleteDatabaseOperation
Wrapper for interacting with a long-running deleteDatabase operation.
|
class |
DeleteDatabaseRequest |
class |
DeleteEndpointOperation
Wrapper for interacting with a long-running deleteEndpoint operation.
|
class |
DeleteEndpointRequest |
class |
DeleteProjectOperation
Wrapper for interacting with a long-running deleteProject operation.
|
class |
DeleteProjectRequest |
class |
DeleteRoleOperation
Wrapper for interacting with a long-running deleteRole operation.
|
class |
DeleteRoleRequest |
class |
DeleteSyncedTableOperation
Wrapper for interacting with a long-running deleteSyncedTable operation.
|
class |
DeleteSyncedTableRequest |
class |
DeltaTableSyncInfo |
class |
Endpoint |
class |
EndpointGroupSpec |
class |
EndpointGroupStatus |
class |
EndpointHosts
Encapsulates various hostnames (r/w or r/o, pooled or not) for an endpoint.
|
class |
EndpointOperationMetadata |
class |
EndpointSettings
A collection of settings for a compute endpoint.
|
class |
EndpointSpec |
class |
EndpointStatus |
class |
EndpointStatusState
The state of the compute endpoint.
|
class |
EndpointType
The compute endpoint type.
|
class |
ErrorCode
Error codes returned by Databricks APIs to indicate specific failure conditions.
|
class |
GenerateDatabaseCredentialRequest |
class |
GetBranchRequest |
class |
GetCatalogRequest |
class |
GetDatabaseRequest |
class |
GetEndpointRequest |
class |
GetOperationRequest |
class |
GetProjectRequest |
class |
GetRoleRequest |
class |
GetSyncedTableRequest |
class |
InitialEndpointSpec
Configuration for the initial Read/Write endpoint created during project creation.
|
class |
ListBranchesRequest |
class |
ListBranchesResponse |
class |
ListDatabasesRequest |
class |
ListDatabasesResponse |
class |
ListEndpointsRequest |
class |
ListEndpointsResponse |
class |
ListProjectsRequest |
class |
ListProjectsResponse |
class |
ListRolesRequest |
class |
ListRolesResponse |
class |
NewPipelineSpec |
class |
Operation
This resource represents a long-running operation that is the result of a network API call.
|
class |
PostgresAPI
Use the Postgres API to create and manage Lakebase Autoscaling Postgres infrastructure, including
projects, branches, compute endpoints, and roles.
|
interface |
PostgresService
Use the Postgres API to create and manage Lakebase Autoscaling Postgres infrastructure, including
projects, branches, compute endpoints, and roles.
|
class |
Project |
class |
ProjectCustomTag |
class |
ProjectDefaultEndpointSettings
A collection of settings for a compute endpoint.
|
class |
ProjectOperationMetadata |
class |
ProjectSpec |
class |
ProjectStatus |
class |
ProvisioningInfoState |
class |
ProvisioningPhase
The current phase of the data synchronization pipeline.
|
class |
RequestedClaims |
class |
RequestedClaimsPermissionSet |
class |
RequestedResource |
class |
Role
Role represents a Postgres role within a Branch.
|
class |
RoleAttributes
Attributes that can be granted to a Postgres role.
|
class |
RoleAuthMethod
How the role is authenticated when connecting to Postgres.
|
class |
RoleIdentityType
The type of the Databricks managed identity that this Role represents.
|
class |
RoleMembershipRole
Roles that the DatabaseInstanceRole can be a member of.
|
class |
RoleOperationMetadata |
class |
RoleRoleSpec |
class |
RoleRoleStatus |
class |
SyncedTable |
class |
SyncedTableOperationMetadata
Metadata for SyncedTable long-running operations.
|
class |
SyncedTablePipelineProgress
Progress information of the Synced Table data synchronization pipeline.
|
class |
SyncedTablePosition |
class |
SyncedTableState
The state of a synced table.
|
class |
SyncedTableSyncedTableSpec |
class |
SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy
Scheduling policy of the synced table's underlying pipeline.
|
class |
SyncedTableSyncedTableStatus |
class |
UndeleteProjectOperation
Wrapper for interacting with a long-running undeleteProject operation.
|
class |
UndeleteProjectRequest
Request to restore a soft-deleted project within its retention period.
|
class |
UpdateBranchOperation
Wrapper for interacting with a long-running updateBranch operation.
|
class |
UpdateBranchRequest |
class |
UpdateDatabaseOperation
Wrapper for interacting with a long-running updateDatabase operation.
|
class |
UpdateDatabaseRequest |
class |
UpdateEndpointOperation
Wrapper for interacting with a long-running updateEndpoint operation.
|
class |
UpdateEndpointRequest |
class |
UpdateProjectOperation
Wrapper for interacting with a long-running updateProject operation.
|
class |
UpdateProjectRequest |
class |
UpdateRoleOperation
Wrapper for interacting with a long-running updateRole operation.
|
class |
UpdateRoleRequest |
| Modifier and Type | Class and Description |
|---|---|
class |
AwsCredentials |
class |
AwsKeyInfo |
class |
AzureKeyInfo |
class |
AzureWorkspaceInfo |
class |
CloudResourceContainer |
class |
CreateAwsKeyInfo |
class |
CreateAzureKeyInfo |
class |
CreateCredentialAwsCredentials |
class |
CreateCredentialRequest |
class |
CreateCredentialStsRole |
class |
CreateCustomerManagedKeyRequest |
class |
CreateGcpKeyInfo |
class |
CreateNetworkRequest |
class |
CreatePrivateAccessSettingsRequest |
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 |
CustomerFacingComputeMode
Corresponds to compute mode defined here:
https://src.dev.databricks.com/databricks/universe@9076536b18479afd639d1c1f9dd5a59f72215e69/-/blob/central/api/common.proto?
|
class |
CustomerFacingGcpCloudResourceContainer |
class |
CustomerFacingStorageMode |
class |
CustomerManagedKey |
class |
DeleteCredentialRequest |
class |
DeleteEncryptionKeyRequest |
class |
DeleteNetworkRequest |
class |
DeletePrivateAccesRequest |
class |
DeleteStorageRequest |
class |
DeleteVpcEndpointRequest |
class |
DeleteWorkspaceRequest |
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 |
class |
ErrorType
ErrorType and WarningType are used to represent the type of error or warning by NetworkHealth and
NetworkWarning defined in central/api/accounts/accounts.proto
|
class |
GcpCommonNetworkConfig
The shared network config for GCP workspace.
|
class |
GcpKeyInfo |
class |
GcpManagedNetworkConfig
The network configuration for the workspace.
|
class |
GcpNetworkInfo |
class |
GcpServiceAccount |
class |
GcpVpcEndpointInfo |
class |
GetCredentialRequest |
class |
GetEncryptionKeyRequest |
class |
GetNetworkRequest |
class |
GetPrivateAccesRequest |
class |
GetStorageRequest |
class |
GetVpcEndpointRequest |
class |
GetWorkspaceRequest |
class |
GkeConfig
The configurations of the GKE cluster used by the GCP workspace.
|
class |
GkeConfigConnectivityType
Specifies the network connectivity types for the GKE nodes and the GKE master network.
|
class |
KeyAccessConfiguration
The credential ID that is used to access the key vault.
|
class |
KeyUseCase |
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 |
class |
NetworkWarning |
class |
PricingTier |
class |
PrivateAccessAPI
These APIs manage private access settings for this account.
|
class |
PrivateAccessLevel |
interface |
PrivateAccessService
These APIs manage private access settings for this account.
|
class |
PrivateAccessSettings |
class |
ReplacePrivateAccessSettingsRequest |
class |
RootBucketInfo |
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 |
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 |
class |
WarningType |
class |
Workspace |
class |
WorkspaceNetwork
The network configuration for workspaces.
|
class |
WorkspacesAPI
These APIs manage workspaces for this account.
|
interface |
WorkspacesService
These APIs manage workspaces for this account.
|
class |
WorkspaceStatus
The different statuses of a workspace.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AnomalyDetectionConfig |
class |
AnomalyDetectionRunStatus
Status of Anomaly Detection Job Run
|
class |
CreateQualityMonitorRequest |
class |
DeleteQualityMonitorRequest |
class |
GetQualityMonitorRequest |
class |
ListQualityMonitorRequest |
class |
ListQualityMonitorResponse |
class |
PercentNullValidityCheck |
class |
QualityMonitor |
class |
QualityMonitorV2API
Deprecated: Please use the Data Quality Monitoring API instead (REST:
/api/data-quality/v1/monitors).
|
interface |
QualityMonitorV2Service
Deprecated: Please use the Data Quality Monitoring API instead (REST:
/api/data-quality/v1/monitors).
|
class |
RangeValidityCheck |
class |
UniquenessValidityCheck |
class |
UpdateQualityMonitorRequest |
class |
ValidityCheckConfiguration |
| Modifier and Type | Class and Description |
|---|---|
class |
AccountIpAccessEnable |
class |
AccountIpAccessListsAPI
The Accounts IP Access List API enables account admins to configure IP access lists for access to
the account console.
|
interface |
AccountIpAccessListsService
The Accounts IP Access List API enables account admins to configure IP access lists for access to
the account console.
|
class |
AccountNetworkPolicy |
class |
AccountSettingsAPI
Accounts Settings API allows users to manage settings at the account level.
|
interface |
AccountSettingsService
Accounts Settings API allows users to manage settings at the account level.
|
class |
AibiDashboardEmbeddingAccessPolicy |
class |
AibiDashboardEmbeddingAccessPolicyAccessPolicyType |
class |
AibiDashboardEmbeddingAccessPolicyAPI
Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or
disabled at the workspace level.
|
interface |
AibiDashboardEmbeddingAccessPolicyService
Controls whether AI/BI published dashboard embedding is enabled, conditionally enabled, or
disabled at the workspace level.
|
class |
AibiDashboardEmbeddingAccessPolicySetting |
class |
AibiDashboardEmbeddingApprovedDomains |
class |
AibiDashboardEmbeddingApprovedDomainsAPI
Controls the list of domains approved to host the embedded AI/BI dashboards.
|
interface |
AibiDashboardEmbeddingApprovedDomainsService
Controls the list of domains approved to host the embedded AI/BI dashboards.
|
class |
AibiDashboardEmbeddingApprovedDomainsSetting |
class |
AutomaticClusterUpdateAPI
Controls whether automatic cluster update is enabled for the current workspace.
|
interface |
AutomaticClusterUpdateService
Controls whether automatic cluster update is enabled for the current workspace.
|
class |
AutomaticClusterUpdateSetting |
class |
BooleanMessage |
class |
ClusterAutoRestartMessage |
class |
ClusterAutoRestartMessageEnablementDetails
Contains an information about the enablement status judging (e.g. whether the enterprise tier is
enabled) This is only additional information that MUST NOT be used to decide whether the setting
is enabled or not.
|
class |
ClusterAutoRestartMessageMaintenanceWindow |
class |
ClusterAutoRestartMessageMaintenanceWindowDayOfWeek |
class |
ClusterAutoRestartMessageMaintenanceWindowWeekDayBasedSchedule |
class |
ClusterAutoRestartMessageMaintenanceWindowWeekDayFrequency |
class |
ClusterAutoRestartMessageMaintenanceWindowWindowStartTime |
class |
ComplianceSecurityProfile
SHIELD feature: CSP Compliance Security Profile (CSP) enables enhanced compliance controls on the
workspace.
|
class |
ComplianceSecurityProfileAPI
Controls whether to enable the compliance security profile for the current workspace.
|
interface |
ComplianceSecurityProfileService
Controls whether to enable the compliance security profile for the current workspace.
|
class |
ComplianceSecurityProfileSetting |
class |
ComplianceStandard
Compliance standard for SHIELD customers.
|
class |
Config |
class |
CreateIpAccessList
Details required to configure a block list or allow list.
|
class |
CreateIpAccessListResponse
An IP access list was successfully created.
|
class |
CreateNetworkConnectivityConfigRequest |
class |
CreateNetworkConnectivityConfiguration
Properties of the new network connectivity configuration.
|
class |
CreateNetworkPolicyRequest |
class |
CreateNotificationDestinationRequest |
class |
CreateOboTokenRequest
Configuration details for creating on-behalf tokens.
|
class |
CreateOboTokenResponse
An on-behalf token was successfully created for the service principal.
|
class |
CreatePrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
CreatePrivateEndpointRuleRequest |
class |
CreateTokenRequest |
class |
CreateTokenResponse |
class |
CredentialsManagerAPI
Credentials manager interacts with with Identity Providers to to perform token exchanges using
stored credentials and refresh tokens.
|
interface |
CredentialsManagerService
Credentials manager interacts with with Identity Providers to to perform token exchanges using
stored credentials and refresh tokens.
|
class |
CspEnablementAccount
Account level policy for CSP
|
class |
CspEnablementAccountAPI
The compliance security profile settings at the account level control whether to enable it for
new workspaces.
|
interface |
CspEnablementAccountService
The compliance security profile settings at the account level control whether to enable it for
new workspaces.
|
class |
CspEnablementAccountSetting |
class |
CustomerFacingIngressNetworkPolicy
This proto is under development.
|
class |
CustomerFacingIngressNetworkPolicyAccountApiDestination |
class |
CustomerFacingIngressNetworkPolicyAccountDatabricksOneDestination |
class |
CustomerFacingIngressNetworkPolicyAccountUiDestination |
class |
CustomerFacingIngressNetworkPolicyApiScopeQualifier
Qualifies the breadth of API access permitted by an ingress network policy rule.
|
class |
CustomerFacingIngressNetworkPolicyAppsRuntimeDestination |
class |
CustomerFacingIngressNetworkPolicyAuthentication |
class |
CustomerFacingIngressNetworkPolicyAuthenticationIdentity |
class |
CustomerFacingIngressNetworkPolicyAuthenticationIdentityPrincipalType |
class |
CustomerFacingIngressNetworkPolicyAuthenticationIdentityType |
class |
CustomerFacingIngressNetworkPolicyCrossWorkspaceAccess |
class |
CustomerFacingIngressNetworkPolicyCrossWorkspaceAccessRestrictionMode |
class |
CustomerFacingIngressNetworkPolicyCrossWorkspaceIngressRule |
class |
CustomerFacingIngressNetworkPolicyCrossWorkspaceRequestOrigin |
class |
CustomerFacingIngressNetworkPolicyEndpoints |
class |
CustomerFacingIngressNetworkPolicyIpRanges |
class |
CustomerFacingIngressNetworkPolicyLakebaseRuntimeDestination |
class |
CustomerFacingIngressNetworkPolicyPrivateAccess |
class |
CustomerFacingIngressNetworkPolicyPrivateAccessRestrictionMode |
class |
CustomerFacingIngressNetworkPolicyPrivateIngressRule |
class |
CustomerFacingIngressNetworkPolicyPrivateRequestOrigin |
class |
CustomerFacingIngressNetworkPolicyPublicAccess |
class |
CustomerFacingIngressNetworkPolicyPublicAccessRestrictionMode |
class |
CustomerFacingIngressNetworkPolicyPublicIngressRule
An ingress rule is enforced when a request satisfies all specified attributes — including request
origin, destination, and authentication.
|
class |
CustomerFacingIngressNetworkPolicyPublicRequestOrigin |
class |
CustomerFacingIngressNetworkPolicyRequestDestination |
class |
CustomerFacingIngressNetworkPolicyWorkspaceApiDestination |
class |
CustomerFacingIngressNetworkPolicyWorkspaceIdList |
class |
CustomerFacingIngressNetworkPolicyWorkspaceUiDestination |
class |
CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
CustomerFacingNetworkConnectivityConfigAwsPrivateEndpointRulePrivateLinkConnectionState |
class |
DashboardEmailSubscriptions |
class |
DashboardEmailSubscriptionsAPI
Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can
send subscription emails containing PDFs and/or images of the dashboard.
|
interface |
DashboardEmailSubscriptionsService
Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can
send subscription emails containing PDFs and/or images of the dashboard.
|
class |
DefaultNamespaceAPI
The default namespace setting API allows users to configure the default namespace for a
Databricks workspace.
|
interface |
DefaultNamespaceService
The default namespace setting API allows users to configure the default namespace for a
Databricks workspace.
|
class |
DefaultNamespaceSetting
This represents the setting configuration for the default namespace in the Databricks workspace.
|
class |
DefaultWarehouseId |
class |
DefaultWarehouseIdAPI
Warehouse to be selected by default for users in this workspace.
|
interface |
DefaultWarehouseIdService
Warehouse to be selected by default for users in this workspace.
|
class |
DeleteAccountIpAccessEnableRequest |
class |
DeleteAccountIpAccessEnableResponse
The etag is returned.
|
class |
DeleteAccountIpAccessListRequest |
class |
DeleteAibiDashboardEmbeddingAccessPolicySettingRequest |
class |
DeleteAibiDashboardEmbeddingAccessPolicySettingResponse
The etag is returned.
|
class |
DeleteAibiDashboardEmbeddingApprovedDomainsSettingRequest |
class |
DeleteAibiDashboardEmbeddingApprovedDomainsSettingResponse
The etag is returned.
|
class |
DeleteDashboardEmailSubscriptionsRequest |
class |
DeleteDashboardEmailSubscriptionsResponse
The etag is returned.
|
class |
DeleteDefaultNamespaceSettingRequest |
class |
DeleteDefaultNamespaceSettingResponse
The etag is returned.
|
class |
DeleteDefaultWarehouseIdRequest |
class |
DeleteDefaultWarehouseIdResponse
The etag is returned.
|
class |
DeleteDisableLegacyAccessRequest |
class |
DeleteDisableLegacyAccessResponse
The etag is returned.
|
class |
DeleteDisableLegacyDbfsRequest |
class |
DeleteDisableLegacyDbfsResponse
The etag is returned.
|
class |
DeleteDisableLegacyFeaturesRequest |
class |
DeleteDisableLegacyFeaturesResponse
The etag is returned.
|
class |
DeleteIpAccessListRequest |
class |
DeleteLlmProxyPartnerPoweredWorkspaceRequest |
class |
DeleteLlmProxyPartnerPoweredWorkspaceResponse
The etag is returned.
|
class |
DeleteNetworkConnectivityConfigurationRequest |
class |
DeleteNetworkPolicyRequest |
class |
DeleteNotificationDestinationRequest |
class |
DeletePersonalComputeSettingRequest |
class |
DeletePersonalComputeSettingResponse
The etag is returned.
|
class |
DeletePrivateEndpointRuleRequest |
class |
DeleteRestrictWorkspaceAdminsSettingRequest |
class |
DeleteRestrictWorkspaceAdminsSettingResponse
The etag is returned.
|
class |
DeleteSqlResultsDownloadRequest |
class |
DeleteSqlResultsDownloadResponse
The etag is returned.
|
class |
DeleteTokenManagementRequest |
class |
DestinationType |
class |
DisableLegacyAccess |
class |
DisableLegacyAccessAPI
'Disabling legacy access' has the following impacts:
1.
|
interface |
DisableLegacyAccessService
'Disabling legacy access' has the following impacts:
1.
|
class |
DisableLegacyDbfs |
class |
DisableLegacyDbfsAPI
Disabling legacy DBFS has the following implications:
1.
|
interface |
DisableLegacyDbfsService
Disabling legacy DBFS has the following implications:
1.
|
class |
DisableLegacyFeatures |
class |
DisableLegacyFeaturesAPI
Disable legacy features for new Databricks workspaces.
|
interface |
DisableLegacyFeaturesService
Disable legacy features for new Databricks workspaces.
|
class |
EgressNetworkPolicy
The network policies applying for egress traffic.
|
class |
EgressNetworkPolicyInternetAccessPolicy |
class |
EgressNetworkPolicyInternetAccessPolicyInternetDestination
Users can specify accessible internet destinations when outbound access is restricted.
|
class |
EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationFilteringProtocol
The filtering protocol used by the DP.
|
class |
EgressNetworkPolicyInternetAccessPolicyInternetDestinationInternetDestinationType |
class |
EgressNetworkPolicyInternetAccessPolicyLogOnlyMode |
class |
EgressNetworkPolicyInternetAccessPolicyLogOnlyModeLogOnlyModeType |
class |
EgressNetworkPolicyInternetAccessPolicyLogOnlyModeWorkloadType
The values should match the list of workloads used in networkconfig.proto
|
class |
EgressNetworkPolicyInternetAccessPolicyRestrictionMode
At which level can Databricks and Databricks managed compute access Internet.
|
class |
EgressNetworkPolicyInternetAccessPolicyStorageDestination
Users can specify accessible storage destinations.
|
class |
EgressNetworkPolicyInternetAccessPolicyStorageDestinationStorageDestinationType |
class |
EgressNetworkPolicyNetworkAccessPolicy |
class |
EgressNetworkPolicyNetworkAccessPolicyInternetDestination
Users can specify accessible internet destinations when outbound access is restricted.
|
class |
EgressNetworkPolicyNetworkAccessPolicyInternetDestinationInternetDestinationType |
class |
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcement |
class |
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementDryRunModeProductFilter
The values should match the list of workloads used in networkconfig.proto
|
class |
EgressNetworkPolicyNetworkAccessPolicyPolicyEnforcementEnforcementMode |
class |
EgressNetworkPolicyNetworkAccessPolicyRestrictionMode
At which level can Databricks and Databricks managed compute access Internet.
|
class |
EgressNetworkPolicyNetworkAccessPolicyStorageDestination
Users can specify accessible storage destinations.
|
class |
EgressNetworkPolicyNetworkAccessPolicyStorageDestinationStorageDestinationType |
class |
EgressResourceType
The target resources that are supported by Network Connectivity Config.
|
class |
EmailConfig |
class |
EnableExportNotebook |
class |
EnableExportNotebookAPI
Controls whether users can export notebooks and files from the Workspace UI.
|
interface |
EnableExportNotebookService
Controls whether users can export notebooks and files from the Workspace UI.
|
class |
EnableIpAccessListsAPI
Controls the enforcement of IP access lists for accessing the account console.
|
interface |
EnableIpAccessListsService
Controls the enforcement of IP access lists for accessing the account console.
|
class |
EnableNotebookTableClipboard |
class |
EnableNotebookTableClipboardAPI
Controls whether users can copy tabular data to the clipboard via the UI.
|
interface |
EnableNotebookTableClipboardService
Controls whether users can copy tabular data to the clipboard via the UI.
|
class |
EnableResultsDownloading |
class |
EnableResultsDownloadingAPI
Controls whether users can download notebook results.
|
interface |
EnableResultsDownloadingService
Controls whether users can download notebook results.
|
class |
EnhancedSecurityMonitoring
SHIELD feature: ESM Enhanced Security Monitoring (ESM) enables additional security monitoring on
the workspace.
|
class |
EnhancedSecurityMonitoringAPI
Controls whether enhanced security monitoring is enabled for the current workspace.
|
interface |
EnhancedSecurityMonitoringService
Controls whether enhanced security monitoring is enabled for the current workspace.
|
class |
EnhancedSecurityMonitoringSetting |
class |
EsmEnablementAccount
Account level policy for ESM
|
class |
EsmEnablementAccountAPI
The enhanced security monitoring setting at the account level controls whether to enable the
feature on new workspaces.
|
interface |
EsmEnablementAccountService
The enhanced security monitoring setting at the account level controls whether to enable the
feature on new workspaces.
|
class |
EsmEnablementAccountSetting |
class |
ExchangeToken
The exchange token is the result of the token exchange with the IdP
|
class |
ExchangeTokenRequest
Exchange a token with the IdP
|
class |
ExchangeTokenResponse
Exhanged tokens were successfully returned.
|
class |
FetchIpAccessListResponse
An IP access list was successfully returned.
|
class |
GcpEndpoint |
class |
GenericWebhookConfig |
class |
GetAccountIpAccessEnableRequest |
class |
GetAccountIpAccessListRequest |
class |
GetAibiDashboardEmbeddingAccessPolicySettingRequest |
class |
GetAibiDashboardEmbeddingApprovedDomainsSettingRequest |
class |
GetAutomaticClusterUpdateSettingRequest |
class |
GetComplianceSecurityProfileSettingRequest |
class |
GetCspEnablementAccountSettingRequest |
class |
GetDashboardEmailSubscriptionsRequest |
class |
GetDefaultNamespaceSettingRequest |
class |
GetDefaultWarehouseIdRequest |
class |
GetDisableLegacyAccessRequest |
class |
GetDisableLegacyDbfsRequest |
class |
GetDisableLegacyFeaturesRequest |
class |
GetEnhancedSecurityMonitoringSettingRequest |
class |
GetEsmEnablementAccountSettingRequest |
class |
GetIpAccessListRequest |
class |
GetIpAccessListResponse |
class |
GetIpAccessListsResponse
IP access lists were successfully returned.
|
class |
GetLlmProxyPartnerPoweredAccountRequest |
class |
GetLlmProxyPartnerPoweredEnforceRequest |
class |
GetLlmProxyPartnerPoweredWorkspaceRequest |
class |
GetNetworkConnectivityConfigurationRequest |
class |
GetNetworkPolicyRequest |
class |
GetNotificationDestinationRequest |
class |
GetPersonalComputeSettingRequest |
class |
GetPrivateEndpointRuleRequest |
class |
GetRestrictWorkspaceAdminsSettingRequest |
class |
GetSqlResultsDownloadRequest |
class |
GetStatusRequest |
class |
GetTokenManagementRequest |
class |
GetTokenPermissionLevelsResponse |
class |
GetTokenResponse
Token with specified Token ID was successfully returned.
|
class |
GetWorkspaceNetworkOptionRequest |
class |
IpAccessListInfo
Definition of an IP Access list
|
class |
IpAccessListsAPI
IP Access List enables admins to configure IP access lists.
|
interface |
IpAccessListsService
IP Access List enables admins to configure IP access lists.
|
class |
ListIpAccessListResponse
IP access lists were successfully returned.
|
class |
ListNetworkConnectivityConfigurationsRequest |
class |
ListNetworkConnectivityConfigurationsResponse
The network connectivity configuration list was successfully retrieved.
|
class |
ListNetworkPoliciesRequest |
class |
ListNetworkPoliciesResponse |
class |
ListNotificationDestinationsRequest |
class |
ListNotificationDestinationsResponse |
class |
ListNotificationDestinationsResult |
class |
ListPrivateEndpointRulesRequest |
class |
ListPrivateEndpointRulesResponse
The private endpoint rule list was successfully retrieved.
|
class |
ListPublicTokensResponse |
class |
ListTokenManagementRequest |
class |
ListTokensResponse
Tokens were successfully returned.
|
class |
ListType
Type of IP access list.
|
class |
LlmProxyPartnerPoweredAccount |
class |
LlmProxyPartnerPoweredAccountAPI
Determines if partner powered models are enabled or not for a specific account
|
interface |
LlmProxyPartnerPoweredAccountService
Determines if partner powered models are enabled or not for a specific account
This is the high-level interface, that contains generated methods.
|
class |
LlmProxyPartnerPoweredEnforce |
class |
LlmProxyPartnerPoweredEnforceAPI
Determines if the account-level partner-powered setting value is enforced upon the
workspace-level partner-powered setting
|
interface |
LlmProxyPartnerPoweredEnforceService
Determines if the account-level partner-powered setting value is enforced upon the
workspace-level partner-powered setting
This is the high-level interface, that contains generated methods.
|
class |
LlmProxyPartnerPoweredWorkspace |
class |
LlmProxyPartnerPoweredWorkspaceAPI
Determines if partner powered models are enabled or not for a specific workspace
|
interface |
LlmProxyPartnerPoweredWorkspaceService
Determines if partner powered models are enabled or not for a specific workspace
This is the high-level interface, that contains generated methods.
|
class |
MicrosoftTeamsConfig |
class |
NccAwsStableIpRule
The stable AWS IP CIDR blocks.
|
class |
NccAzurePrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
NccAzurePrivateEndpointRuleConnectionState |
class |
NccAzureServiceEndpointRule
The stable Azure service endpoints.
|
class |
NccEgressConfig |
class |
NccEgressDefaultRules
Default rules don't have specific targets.
|
class |
NccEgressTargetRules
Target rule controls the egress rules that are dedicated to specific resources.
|
class |
NccPrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
NccPrivateEndpointRulePrivateLinkConnectionState |
class |
NetworkConnectivityAPI
These APIs provide configurations for the network connectivity of your workspaces for serverless
compute resources.
|
class |
NetworkConnectivityConfiguration
Properties of the new network connectivity configuration.
|
interface |
NetworkConnectivityService
These APIs provide configurations for the network connectivity of your workspaces for serverless
compute resources.
|
class |
NetworkPoliciesAPI
These APIs manage network policies for this account.
|
interface |
NetworkPoliciesService
These APIs manage network policies for this account.
|
class |
NetworkPolicyEgress
The network policies applying for egress traffic.
|
class |
NotificationDestination |
class |
NotificationDestinationsAPI
The notification destinations API lets you programmatically manage a workspace's notification
destinations.
|
interface |
NotificationDestinationsService
The notification destinations API lets you programmatically manage a workspace's notification
destinations.
|
class |
PagerdutyConfig |
class |
PartitionId
Partition by workspace or account
|
class |
PersonalComputeAPI
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
class |
PersonalComputeMessage |
class |
PersonalComputeMessageEnum
ON: Grants all users in all workspaces access to the Personal Compute default policy, allowing
all users to create single-machine compute resources.
|
interface |
PersonalComputeService
The Personal Compute enablement setting lets you control which users can use the Personal Compute
default policy to create compute resources.
|
class |
PersonalComputeSetting |
class |
PublicTokenInfo |
class |
ReplaceIpAccessList
Details required to replace an IP access list.
|
class |
RestrictWorkspaceAdminsAPI
The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.
|
class |
RestrictWorkspaceAdminsMessage |
class |
RestrictWorkspaceAdminsMessageStatus |
interface |
RestrictWorkspaceAdminsService
The Restrict Workspace Admins setting lets you control the capabilities of workspace admins.
|
class |
RestrictWorkspaceAdminsSetting |
class |
RevokeTokenRequest |
class |
SettingsAPI
Workspace Settings API allows users to manage settings at the workspace level.
|
interface |
SettingsService
Workspace Settings API allows users to manage settings at the workspace level.
|
class |
SlackConfig |
class |
SqlResultsDownload |
class |
SqlResultsDownloadAPI
Controls whether users within the workspace are allowed to download results from the SQL Editor
and AI/BI Dashboards UIs.
|
interface |
SqlResultsDownloadService
Controls whether users within the workspace are allowed to download results from the SQL Editor
and AI/BI Dashboards UIs.
|
class |
StringMessage |
class |
TokenAccessControlRequest |
class |
TokenAccessControlResponse |
class |
TokenInfo |
class |
TokenManagementAPI
Enables administrators to get all tokens and delete tokens for other users.
|
interface |
TokenManagementService
Enables administrators to get all tokens and delete tokens for other users.
|
class |
TokenPermission |
class |
TokenPermissionLevel
Permission level
|
class |
TokenPermissions |
class |
TokenPermissionsDescription |
class |
TokenPermissionsRequest |
class |
TokensAPI
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and
access Databricks REST APIs.
|
interface |
TokensService
The Token API allows you to create, list, and revoke tokens that can be used to authenticate and
access Databricks REST APIs.
|
class |
TokenType
The type of token request.
|
class |
UpdateAccountIpAccessEnableRequest
Details required to update a setting.
|
class |
UpdateAibiDashboardEmbeddingAccessPolicySettingRequest
Details required to update a setting.
|
class |
UpdateAibiDashboardEmbeddingApprovedDomainsSettingRequest
Details required to update a setting.
|
class |
UpdateAutomaticClusterUpdateSettingRequest
Details required to update a setting.
|
class |
UpdateComplianceSecurityProfileSettingRequest
Details required to update a setting.
|
class |
UpdateCspEnablementAccountSettingRequest
Details required to update a setting.
|
class |
UpdateDashboardEmailSubscriptionsRequest
Details required to update a setting.
|
class |
UpdateDefaultNamespaceSettingRequest
Details required to update a setting.
|
class |
UpdateDefaultWarehouseIdRequest
Details required to update a setting.
|
class |
UpdateDisableLegacyAccessRequest
Details required to update a setting.
|
class |
UpdateDisableLegacyDbfsRequest
Details required to update a setting.
|
class |
UpdateDisableLegacyFeaturesRequest
Details required to update a setting.
|
class |
UpdateEnableExportNotebookRequest
Details required to update a setting.
|
class |
UpdateEnableNotebookTableClipboardRequest
Details required to update a setting.
|
class |
UpdateEnableResultsDownloadingRequest
Details required to update a setting.
|
class |
UpdateEnhancedSecurityMonitoringSettingRequest
Details required to update a setting.
|
class |
UpdateEsmEnablementAccountSettingRequest
Details required to update a setting.
|
class |
UpdateIpAccessList
Details required to update an IP access list.
|
class |
UpdateLlmProxyPartnerPoweredAccountRequest
Details required to update a setting.
|
class |
UpdateLlmProxyPartnerPoweredEnforceRequest
Details required to update a setting.
|
class |
UpdateLlmProxyPartnerPoweredWorkspaceRequest
Details required to update a setting.
|
class |
UpdateNccPrivateEndpointRuleRequest |
class |
UpdateNetworkPolicyRequest |
class |
UpdateNotificationDestinationRequest |
class |
UpdatePersonalComputeSettingRequest
Details required to update a setting.
|
class |
UpdatePrivateEndpointRule
Properties of the new private endpoint rule.
|
class |
UpdateRestrictWorkspaceAdminsSettingRequest
Details required to update a setting.
|
class |
UpdateSqlResultsDownloadRequest
Details required to update a setting.
|
class |
UpdateTokenRequest |
class |
UpdateTokenResponse |
class |
UpdateWorkspaceNetworkOptionRequest |
class |
WorkspaceConfAPI
This API allows updating known workspace settings for advanced users.
|
interface |
WorkspaceConfService
This API allows updating known workspace settings for advanced users.
|
class |
WorkspaceNetworkConfigurationAPI
These APIs allow configuration of network settings for Databricks workspaces by selecting which
network policy to associate with the workspace.
|
interface |
WorkspaceNetworkConfigurationService
These APIs allow configuration of network settings for Databricks workspaces by selecting which
network policy to associate with the workspace.
|
class |
WorkspaceNetworkOption |
| Modifier and Type | Class and Description |
|---|---|
class |
AuthenticationType
The delta sharing authentication type.
|
class |
ColumnTypeName
UC supported column types Copied from
https://src.dev.databricks.com/databricks/universe@23a85902bb58695ab9293adc9f327b0714b55e72/-/blob/managed-catalog/api/messages/table.proto?
|
class |
CreateFederationPolicyRequest |
class |
CreateProvider |
class |
CreateRecipient |
class |
CreateShare |
class |
DeleteFederationPolicyRequest |
class |
DeleteProviderRequest |
class |
DeleteRecipientRequest |
class |
DeleteShareRequest |
class |
DeltaSharingDependency
Represents a UC dependency.
|
class |
DeltaSharingDependencyList
Represents a list of dependencies.
|
class |
DeltaSharingFunction |
class |
DeltaSharingFunctionDependency
A Function in UC as a dependency.
|
class |
DeltaSharingTableDependency
A Table in UC as a dependency.
|
class |
FederationPolicy |
class |
FunctionParameterInfo
Represents a parameter of a function.
|
class |
FunctionParameterInfos |
class |
FunctionParameterMode |
class |
FunctionParameterType |
class |
GetActivationUrlInfoRequest |
class |
GetFederationPolicyRequest |
class |
GetProviderRequest |
class |
GetRecipientRequest |
class |
GetRecipientSharePermissionsResponse |
class |
GetSharePermissionsResponse |
class |
GetShareRequest |
class |
IpAccessList |
class |
ListFederationPoliciesRequest |
class |
ListFederationPoliciesResponse |
class |
ListProviderShareAssetsRequest |
class |
ListProviderShareAssetsResponse
Response to ListProviderShareAssets, which contains the list of assets of a share.
|
class |
ListProviderSharesResponse |
class |
ListProvidersRequest |
class |
ListProvidersResponse |
class |
ListRecipientsRequest |
class |
ListRecipientsResponse |
class |
ListSharesRequest |
class |
ListSharesResponse |
class |
NotebookFile |
class |
OidcFederationPolicy
Specifies the policy to use for validating OIDC claims in your federated tokens from Delta
Sharing Clients.
|
class |
Partition |
class |
PartitionValue |
class |
PartitionValueOp |
class |
PermissionsChange |
class |
Privilege |
class |
PrivilegeAssignment |
class |
ProviderInfo |
class |
ProvidersAPI
A data provider is an object representing the organization in the real world who shares the data.
|
class |
ProviderShare |
interface |
ProvidersService
A data provider is an object representing the organization in the real world who shares the data.
|
class |
RecipientActivationAPI
The Recipient Activation API is only applicable in the open sharing model where the recipient
object has the authentication type of `TOKEN`.
|
interface |
RecipientActivationService
The Recipient Activation API is only applicable in the open sharing model where the recipient
object has the authentication type of `TOKEN`.
|
class |
RecipientFederationPoliciesAPI
The Recipient Federation Policies APIs are only applicable in the open sharing model where the
recipient object has the authentication type of `OIDC_RECIPIENT`, enabling data sharing from
Databricks to non-Databricks recipients.
|
interface |
RecipientFederationPoliciesService
The Recipient Federation Policies APIs are only applicable in the open sharing model where the
recipient object has the authentication type of `OIDC_RECIPIENT`, enabling data sharing from
Databricks to non-Databricks recipients.
|
class |
RecipientInfo |
class |
RecipientProfile |
class |
RecipientsAPI
A recipient is an object you create using :method:recipients/create to represent an organization
which you want to allow access shares.
|
interface |
RecipientsService
A recipient is an object you create using :method:recipients/create to represent an organization
which you want to allow access shares.
|
class |
RecipientTokenInfo |
class |
RegisteredModelAlias |
class |
RetrieveTokenRequest |
class |
RetrieveTokenResponse |
class |
RotateRecipientToken |
class |
SecurablePropertiesKvPairs
An object with __properties__ containing map of key-value properties attached to the securable.
|
class |
Share |
class |
SharedDataObject |
class |
SharedDataObjectDataObjectType |
class |
SharedDataObjectHistoryDataSharingStatus |
class |
SharedDataObjectStatus |
class |
SharedDataObjectUpdate |
class |
SharedDataObjectUpdateAction |
class |
SharedSecurableKind
The SecurableKind of a delta-shared object.
|
class |
ShareInfo |
class |
SharePermissionsRequest |
class |
SharesAPI
A share is a container instantiated with :method:shares/create.
|
class |
SharesListRequest |
interface |
SharesService
A share is a container instantiated with :method:shares/create.
|
class |
ShareToPrivilegeAssignment |
class |
Table |
class |
UpdateProvider |
class |
UpdateRecipient |
class |
UpdateShare |
class |
UpdateSharePermissions |
class |
UpdateSharePermissionsResponse |
class |
Volume |
| Modifier and Type | Class and Description |
|---|---|
class |
AccessControl |
class |
Aggregation |
class |
Alert |
class |
AlertCondition |
class |
AlertConditionOperand |
class |
AlertConditionThreshold |
class |
AlertEvaluationState
UNSPECIFIED - default unspecify value for proto enum, do not use it in the code UNKNOWN - alert
not yet evaluated TRIGGERED - alert is triggered OK - alert is not triggered ERROR - alert
evaluation failed
|
class |
AlertLifecycleState |
class |
AlertOperandColumn |
class |
AlertOperandValue |
class |
AlertOperator |
class |
AlertOptions
Alert configuration options.
|
class |
AlertOptionsEmptyResultState
State that alert evaluates to when query result is empty.
|
class |
AlertQuery |
class |
AlertsAPI
The alerts API can be used to perform CRUD operations on alerts.
|
class |
AlertsLegacyAPI
The alerts API can be used to perform CRUD operations on alerts.
|
interface |
AlertsLegacyService
The alerts API can be used to perform CRUD operations on alerts.
|
interface |
AlertsService
The alerts API can be used to perform CRUD operations on alerts.
|
class |
AlertState |
class |
AlertsV2API
New version of SQL Alerts
|
interface |
AlertsV2Service
New version of SQL Alerts
This is the high-level interface, that contains generated methods.
|
class |
AlertV2 |
class |
AlertV2Evaluation |
class |
AlertV2Notification |
class |
AlertV2Operand |
class |
AlertV2OperandColumn |
class |
AlertV2OperandValue |
class |
AlertV2RunAs |
class |
AlertV2Subscription |
class |
BaseChunkInfo |
class |
CancelExecutionRequest |
class |
Channel
Configures the channel name and DBSQL version of the warehouse.
|
class |
ChannelInfo
Details about a Channel.
|
class |
ChannelName |
class |
ClientConfig |
class |
ColumnInfo |
class |
ColumnInfoTypeName
The name of the base data type.
|
class |
ComparisonOperator |
class |
CreateAlert |
class |
CreateAlertRequest |
class |
CreateAlertRequestAlert |
class |
CreateAlertV2Request |
class |
CreateDefaultWarehouseOverrideRequest |
class |
CreateQueryRequest |
class |
CreateQueryRequestQuery |
class |
CreateQueryVisualizationsLegacyRequest
Add visualization to a query
|
class |
CreateVisualizationRequest |
class |
CreateVisualizationRequestVisualization |
class |
CreateWarehouseRequest
Creates a new SQL warehouse.
|
class |
CreateWarehouseRequestWarehouseType |
class |
CreateWarehouseResponse |
class |
CreateWidget |
class |
CronSchedule |
class |
Dashboard
A JSON representing a dashboard containing widgets of visualizations and text boxes.
|
class |
DashboardEditContent |
class |
DashboardOptions |
class |
DashboardsAPI
In general, there is little need to modify dashboards using the API.
|
interface |
DashboardsService
In general, there is little need to modify dashboards using the API.
|
class |
DashboardWidgetsAPI
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
interface |
DashboardWidgetsService
This is an evolving API that facilitates the addition and removal of widgets from existing
dashboards within the Databricks Workspace.
|
class |
DataSource
A JSON object representing a DBSQL data source / SQL warehouse.
|
class |
DataSourcesAPI
This API is provided to assist you in making new query objects.
|
interface |
DataSourcesService
This API is provided to assist you in making new query objects.
|
class |
DatePrecision |
class |
DateRange |
class |
DateRangeValue |
class |
DateRangeValueDynamicDateRange |
class |
DateValue |
class |
DateValueDynamicDate |
class |
DbsqlPermissionsAPI
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
interface |
DbsqlPermissionsService
The SQL Permissions API is similar to the endpoints of the :method:permissions/set.
|
class |
DefaultWarehouseOverride
Represents a per-user default warehouse override configuration.
|
class |
DefaultWarehouseOverrideType
Type of default warehouse override behavior.
|
class |
DeleteAlertsLegacyRequest |
class |
DeleteDashboardRequest |
class |
DeleteDashboardWidgetRequest |
class |
DeleteDefaultWarehouseOverrideRequest |
class |
DeleteQueriesLegacyRequest |
class |
DeleteQueryVisualizationsLegacyRequest |
class |
DeleteVisualizationRequest |
class |
DeleteWarehouseRequest |
class |
Disposition |
class |
EditAlert |
class |
EditWarehouseRequest
This is an incremental edit functionality, so all fields except id are optional.
|
class |
EditWarehouseRequestWarehouseType |
class |
EndpointConfPair |
class |
EndpointHealth |
class |
EndpointInfo |
class |
EndpointInfoWarehouseType |
class |
EndpointTagPair |
class |
EndpointTags |
class |
EnumValue |
class |
ExecuteStatementRequest |
class |
ExecuteStatementRequestOnWaitTimeout
When `wait_timeout > 0s`, the call will block up to the specified time.
|
class |
ExternalLink |
class |
ExternalQuerySource |
class |
ExternalQuerySourceJobInfo |
class |
Format |
class |
GetAlertRequest |
class |
GetAlertsLegacyRequest |
class |
GetAlertV2Request |
class |
GetDashboardRequest |
class |
GetDbsqlPermissionRequest |
class |
GetDefaultWarehouseOverrideRequest |
class |
GetQueriesLegacyRequest |
class |
GetQueryRequest |
class |
GetResponse |
class |
GetStatementRequest |
class |
GetStatementResultChunkNRequest |
class |
GetWarehousePermissionLevelsRequest |
class |
GetWarehousePermissionLevelsResponse |
class |
GetWarehousePermissionsRequest |
class |
GetWarehouseRequest |
class |
GetWarehouseResponse |
class |
GetWarehouseResponseWarehouseType |
class |
GetWorkspaceWarehouseConfigResponse |
class |
GetWorkspaceWarehouseConfigResponseSecurityPolicy
Security policy to be used for warehouses
|
class |
LegacyAlert |
class |
LegacyAlertState |
class |
LegacyQuery |
class |
LegacyVisualization
The visualization description API changes frequently and is unsupported.
|
class |
LifecycleState |
class |
ListAlertsRequest |
class |
ListAlertsResponse |
class |
ListAlertsResponseAlert |
class |
ListAlertsV2Request |
class |
ListAlertsV2Response |
class |
ListDashboardsRequest |
class |
ListDefaultWarehouseOverridesRequest |
class |
ListDefaultWarehouseOverridesResponse
Response message for ListDefaultWarehouseOverrides.
|
class |
ListOrder |
class |
ListQueriesLegacyRequest |
class |
ListQueriesRequest |
class |
ListQueriesResponse |
class |
ListQueryHistoryRequest |
class |
ListQueryObjectsResponse |
class |
ListQueryObjectsResponseQuery |
class |
ListResponse |
class |
ListVisualizationsForQueryRequest |
class |
ListVisualizationsForQueryResponse |
class |
ListWarehousesRequest |
class |
ListWarehousesResponse |
class |
MultiValuesOptions |
class |
NumericValue |
class |
ObjectType
A singular noun object type.
|
class |
ObjectTypePlural
Always a plural of the object type.
|
class |
OdbcParams |
class |
OwnableObjectType |
class |
Parameter |
class |
ParameterType |
class |
PermissionLevel
* `CAN_VIEW`: Can view the query * `CAN_RUN`: Can run the query * `CAN_EDIT`: Can edit the query
* `CAN_MANAGE`: Can manage the query
|
class |
PlansState
Possible Reasons for which we have not saved plans in the database
|
class |
QueriesAPI
The queries API can be used to perform CRUD operations on queries.
|
class |
QueriesLegacyAPI
These endpoints are used for CRUD operations on query definitions.
|
interface |
QueriesLegacyService
These endpoints are used for CRUD operations on query definitions.
|
interface |
QueriesService
The queries API can be used to perform CRUD operations on queries.
|
class |
Query |
class |
QueryBackedValue |
class |
QueryEditContent |
class |
QueryFilter |
class |
QueryHistoryAPI
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
interface |
QueryHistoryService
A service responsible for storing and retrieving the list of queries run against SQL endpoints
and serverless compute.
|
class |
QueryInfo |
class |
QueryList |
class |
QueryMetrics
A query metric that encapsulates a set of measurements for a single query.
|
class |
QueryOptions |
class |
QueryParameter |
class |
QueryPostContent |
class |
QueryStatementType |
class |
QueryStatus
Statuses which are also used by OperationStatus in runtime.
|
class |
QueryTag
* A query execution can be annotated with an optional key-value pair to allow users to attribute
the executions by key and optional value to filter by.
|
class |
QueryVisualizationsAPI
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
class |
QueryVisualizationsLegacyAPI
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
interface |
QueryVisualizationsLegacyService
This is an evolving API that facilitates the addition and removal of vizualisations from existing
queries within the Databricks Workspace.
|
interface |
QueryVisualizationsService
This is an evolving API that facilitates the addition and removal of visualizations from existing
queries in the Databricks Workspace.
|
class |
RedashConfigAPI
Redash V2 service for workspace configurations (internal)
|
interface |
RedashConfigService
Redash V2 service for workspace configurations (internal)
This is the high-level interface, that contains generated methods.
|
class |
RepeatedEndpointConfPairs |
class |
RestoreDashboardRequest |
class |
RestoreQueriesLegacyRequest |
class |
ResultData
Contains the result data of a single chunk when using `INLINE` disposition.
|
class |
ResultManifest
The result manifest provides schema and metadata for the result set.
|
class |
ResultSchema
The schema is an ordered list of column descriptions.
|
class |
RunAsMode |
class |
RunAsRole |
class |
SchedulePauseStatus |
class |
ServiceError |
class |
ServiceErrorCode |
class |
SetRequest
Set object ACL
|
class |
SetResponse |
class |
SetWorkspaceWarehouseConfigRequest
Sets the workspace level warehouse configuration that is shared by all SQL warehouses in this
workspace.
|
class |
SetWorkspaceWarehouseConfigRequestSecurityPolicy
Security policy to be used for warehouses
|
class |
SpotInstancePolicy
EndpointSpotInstancePolicy configures whether the endpoint should use spot instances.
|
class |
StartRequest |
class |
State
State of a warehouse.
|
class |
StatementExecutionAPI
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
interface |
StatementExecutionService
The Databricks SQL Statement Execution API can be used to execute SQL statements on a SQL
warehouse and fetch the result.
|
class |
StatementParameterListItem |
class |
StatementResponse |
class |
StatementState |
class |
StatementStatus
The status response includes execution state and if relevant, error information.
|
class |
Status |
class |
StopRequest |
class |
Success |
class |
SuccessMessage |
class |
TaskTimeOverRange |
class |
TaskTimeOverRangeEntry |
class |
TerminationReason |
class |
TerminationReasonCode
The status code indicating why the cluster was terminated
|
class |
TerminationReasonType
type of the termination
|
class |
TextValue |
class |
TimeRange |
class |
TransferOwnershipObjectId |
class |
TransferOwnershipRequest |
class |
TrashAlertRequest |
class |
TrashAlertV2Request |
class |
TrashQueryRequest |
class |
UpdateAlertRequest |
class |
UpdateAlertRequestAlert |
class |
UpdateAlertV2Request |
class |
UpdateDefaultWarehouseOverrideRequest |
class |
UpdateQueryRequest |
class |
UpdateQueryRequestQuery |
class |
UpdateVisualizationRequest |
class |
UpdateVisualizationRequestVisualization |
class |
UpdateWidgetRequest |
class |
User |
class |
Visualization |
class |
WarehouseAccessControlRequest |
class |
WarehouseAccessControlResponse |
class |
WarehousePermission |
class |
WarehousePermissionLevel
Permission level
|
class |
WarehousePermissions |
class |
WarehousePermissionsDescription |
class |
WarehousePermissionsRequest |
class |
WarehousesAPI
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
interface |
WarehousesService
A SQL warehouse is a compute resource that lets you run SQL commands on data objects within
Databricks SQL.
|
class |
WarehouseTypePair
* Configuration values to enable or disable the access to specific warehouse types in the
workspace.
|
class |
WarehouseTypePairWarehouseType |
class |
Widget |
class |
WidgetOptions |
class |
WidgetPosition
Coordinates of this widget on a dashboard.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CreateTagAssignmentRequest |
class |
CreateTagPolicyRequest |
class |
DeleteTagAssignmentRequest |
class |
DeleteTagPolicyRequest |
class |
GetTagAssignmentRequest |
class |
GetTagPolicyRequest |
class |
ListTagAssignmentsRequest |
class |
ListTagAssignmentsResponse |
class |
ListTagPoliciesRequest |
class |
ListTagPoliciesResponse |
class |
TagAssignment |
class |
TagPoliciesAPI
The Tag Policy API allows you to manage policies for governed tags in Databricks.
|
interface |
TagPoliciesService
The Tag Policy API allows you to manage policies for governed tags in Databricks.
|
class |
TagPolicy |
class |
UpdateTagAssignmentRequest |
class |
UpdateTagPolicyRequest |
class |
Value |
class |
WorkspaceEntityTagAssignmentsAPI
Manage tag assignments on workspace-scoped objects.
|
interface |
WorkspaceEntityTagAssignmentsService
Manage tag assignments on workspace-scoped objects.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ColumnInfo |
class |
CreateEndpoint |
class |
CreateVectorIndexRequest |
class |
CustomTag |
class |
DeleteDataResult |
class |
DeleteDataStatus |
class |
DeleteDataVectorIndexRequest |
class |
DeleteDataVectorIndexResponse |
class |
DeleteEndpointRequest |
class |
DeleteIndexRequest |
class |
DeltaSyncVectorIndexSpecRequest |
class |
DeltaSyncVectorIndexSpecResponse |
class |
DirectAccessVectorIndexSpec |
class |
EmbeddingSourceColumn |
class |
EmbeddingVectorColumn |
class |
EndpointInfo |
class |
EndpointScalingInfo |
class |
EndpointStatus
Status information of an endpoint
|
class |
EndpointStatusState
Current state of the endpoint
|
class |
EndpointType
Type of endpoint.
|
class |
GetEndpointRequest |
class |
GetIndexRequest |
class |
GetVectorSearchEndpointPermissionLevelsRequest |
class |
GetVectorSearchEndpointPermissionLevelsResponse |
class |
GetVectorSearchEndpointPermissionsRequest |
class |
IndexSubtype
The subtype of the AI Search index, determining the indexing and retrieval strategy. - `VECTOR`:
Not supported.
|
class |
ListEndpointResponse |
class |
ListEndpointsRequest |
class |
ListIndexesRequest |
class |
ListValue |
class |
ListVectorIndexesResponse |
class |
MapStringValueEntry
Key-value pair.
|
class |
Metric
Metric specification
|
class |
MetricLabel
Label for a metric
|
class |
MetricValue
Single metric value at a specific timestamp
|
class |
MetricValues
Collection of metric values for a specific metric
|
class |
MiniVectorIndex |
class |
PatchEndpointBudgetPolicyRequest |
class |
PatchEndpointBudgetPolicyResponse |
class |
PatchEndpointRequest |
class |
PipelineType
Pipeline execution mode. - `TRIGGERED`: If the pipeline uses the triggered execution mode, the
system stops processing after successfully refreshing the source table in the pipeline once,
ensuring the table is updated based on the data available when the update started. -
`CONTINUOUS`: If the pipeline uses continuous execution, the pipeline processes new data as it
arrives in the source table to keep vector index fresh.
|
class |
QueryVectorIndexNextPageRequest
Request payload for getting next page of results.
|
class |
QueryVectorIndexRequest |
class |
QueryVectorIndexResponse |
class |
RerankerConfig |
class |
RerankerConfigRerankerParameters |
class |
ResultData
Data returned in the query result.
|
class |
ResultManifest
Metadata about the result set.
|
class |
RetrieveUserVisibleMetricsRequest
Request to retrieve user-visible metrics
|
class |
RetrieveUserVisibleMetricsResponse
Response containing user-visible metrics
|
class |
ScalingChangeState |
class |
ScanVectorIndexRequest |
class |
ScanVectorIndexResponse
Response to a scan vector index request.
|
class |
Struct |
class |
SyncIndexRequest |
class |
UpdateEndpointCustomTagsRequest |
class |
UpdateEndpointCustomTagsResponse |
class |
UpsertDataResult |
class |
UpsertDataStatus |
class |
UpsertDataVectorIndexRequest |
class |
UpsertDataVectorIndexResponse |
class |
Value |
class |
VectorIndex |
class |
VectorIndexStatus |
class |
VectorIndexType
There are 2 types of AI Search indexes: - `DELTA_SYNC`: An index that automatically syncs with a
source Delta Table, automatically and incrementally updating the index as the underlying data in
the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write of
vectors and metadata through our REST and SDK APIs.
|
class |
VectorSearchEndpointAccessControlRequest |
class |
VectorSearchEndpointAccessControlResponse |
class |
VectorSearchEndpointPermission |
class |
VectorSearchEndpointPermissionLevel
Permission level
|
class |
VectorSearchEndpointPermissions |
class |
VectorSearchEndpointPermissionsDescription |
class |
VectorSearchEndpointPermissionsRequest |
class |
VectorSearchEndpointsAPI
Endpoint**: Represents the compute resources to host AI Search indexes.
|
interface |
VectorSearchEndpointsService
**Endpoint**: Represents the compute resources to host AI Search indexes.
|
class |
VectorSearchIndexesAPI
**Index**: An efficient representation of your embedding vectors that supports real-time and
efficient approximate nearest neighbor (ANN) search queries.
|
interface |
VectorSearchIndexesService
**Index**: An efficient representation of your embedding vectors that supports real-time and
efficient approximate nearest neighbor (ANN) search queries.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AclItem
An item representing an ACL rule applied to the given principal (user or group) on the associated
scope point.
|
class |
AclPermission
The ACL permission levels for Secret ACLs applied to secret scopes.
|
class |
AzureKeyVaultSecretScopeMetadata
The metadata of the Azure KeyVault for a secret scope of type `AZURE_KEYVAULT`
|
class |
CreateCredentialsRequest |
class |
CreateCredentialsResponse |
class |
CreateRepoRequest |
class |
CreateRepoResponse |
class |
CreateScope |
class |
CredentialInfo |
class |
Delete |
class |
DeleteAcl |
class |
DeleteCredentialsRequest |
class |
DeleteRepoRequest |
class |
DeleteScope |
class |
DeleteSecret |
class |
ExportFormat
The format for workspace import and export.
|
class |
ExportRequest |
class |
ExportResponse
The request field `direct_download` determines whether a JSON response or binary contents are
returned by this endpoint.
|
class |
GetAclRequest |
class |
GetCredentialsRequest |
class |
GetCredentialsResponse |
class |
GetRepoPermissionLevelsRequest |
class |
GetRepoPermissionLevelsResponse |
class |
GetRepoPermissionsRequest |
class |
GetRepoRequest |
class |
GetRepoResponse |
class |
GetSecretRequest |
class |
GetSecretResponse |
class |
GetStatusRequest |
class |
GetWorkspaceObjectPermissionLevelsRequest |
class |
GetWorkspaceObjectPermissionLevelsResponse |
class |
GetWorkspaceObjectPermissionsRequest |
class |
GitCredentialsAPI
Registers personal access token for Databricks to do operations on behalf of the user.
|
interface |
GitCredentialsService
Registers personal access token for Databricks to do operations on behalf of the user.
|
class |
Import |
class |
ImportFormat
The format for workspace import and export.
|
class |
Language
The language of notebook.
|
class |
ListAclsRequest |
class |
ListAclsResponse |
class |
ListCredentialsRequest |
class |
ListCredentialsResponse |
class |
ListReposRequest |
class |
ListReposResponse |
class |
ListResponse |
class |
ListScopesResponse |
class |
ListSecretsRequest |
class |
ListSecretsResponse |
class |
ListWorkspaceRequest |
class |
Mkdirs |
class |
ObjectInfo
The information of the object in workspace.
|
class |
ObjectType
The type of the object in workspace.
|
class |
PutAcl |
class |
PutSecret |
class |
RepoAccessControlRequest |
class |
RepoAccessControlResponse |
class |
RepoInfo
Git folder (repo) information.
|
class |
RepoPermission |
class |
RepoPermissionLevel
Permission level
|
class |
RepoPermissions |
class |
RepoPermissionsDescription |
class |
RepoPermissionsRequest |
class |
ReposAPI
The Repos API allows users to manage their git repos.
|
interface |
ReposService
The Repos API allows users to manage their git repos.
|
class |
ScopeBackendType
The types of secret scope backends in the Secret Manager.
|
class |
SecretMetadata
The metadata about a secret.
|
class |
SecretsAPI
The Secrets API allows you to manage secrets, secret scopes, and access permissions.
|
class |
SecretScope
An organizational resource for storing secrets.
|
interface |
SecretsService
The Secrets API allows you to manage secrets, secret scopes, and access permissions.
|
class |
SparseCheckout
Sparse checkout configuration, it contains options like cone patterns.
|
class |
SparseCheckoutUpdate
Sparse checkout configuration, it contains options like cone patterns.
|
class |
UpdateCredentialsRequest |
class |
UpdateRepoRequest |
class |
WorkspaceAPI
The Workspace API allows you to list, import, export, and delete workspace objects such as
notebooks, files, folders, and dashboards.
|
class |
WorkspaceObjectAccessControlRequest |
class |
WorkspaceObjectAccessControlResponse |
class |
WorkspaceObjectPermission |
class |
WorkspaceObjectPermissionLevel
Permission level
|
class |
WorkspaceObjectPermissions |
class |
WorkspaceObjectPermissionsDescription |
class |
WorkspaceObjectPermissionsRequest |
interface |
WorkspaceService
The Workspace API allows you to list, import, export, and delete workspace objects such as
notebooks, files, folders, and dashboards.
|
Copyright © 2026. All rights reserved.