Package com.databricks.sdk.service.catalog

Interface Summary

Interface	Description
AccountMetastoreAssignmentsService	These APIs manage metastore assignments to a workspace.
AccountMetastoresService	These APIs manage Unity Catalog metastores for an account.
AccountStorageCredentialsService	These APIs manage storage credentials for a particular metastore.
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.
CatalogsService	A catalog is the first layer of Unity Catalog’s three-level namespace.
ConnectionsService	Connections allow for creating a connection to an external data source.
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.
FunctionsService	Functions implement User-Defined Functions (UDFs) in Unity Catalog.
GrantsService	In Unity Catalog, data is secure by default.
MetastoresService	A metastore is the top-level container of objects in Unity Catalog.
ModelVersionsService	Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
OnlineTablesService	Online tables provide lower latency and higher QPS access to data from Delta tables.
QualityMonitorsService	A monitor computes and monitors data or model quality metrics for a table over time.
RegisteredModelsService	Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
SchemasService	A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
StorageCredentialsService	A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant.
SystemSchemasService	A system schema is a schema that lives within the system catalog.
TableConstraintsService	Primary key and foreign key constraints encode relationships between fields in tables.
TablesService	A table resides in the third layer of Unity Catalog’s three-level namespace.
VolumesService	Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and processing files.
WorkspaceBindingsService	A securable in Databricks can be configured as __OPEN__ or __ISOLATED__.

Class Summary

Class	Description
AccountMetastoreAssignmentsAPI	These APIs manage metastore assignments to a workspace.
AccountMetastoresAPI	These APIs manage Unity Catalog metastores for an account.
AccountsCreateMetastore
AccountsCreateMetastoreAssignment
AccountsCreateStorageCredential
AccountsMetastoreAssignment
AccountsMetastoreInfo
AccountsStorageCredentialInfo
AccountStorageCredentialsAPI	These APIs manage storage credentials for a particular metastore.
AccountsUpdateMetastore
AccountsUpdateMetastoreAssignment
AccountsUpdateStorageCredential
ArtifactAllowlistInfo
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.
ArtifactMatcher
AssignResponse
AwsIamRoleRequest
AwsIamRoleResponse
AzureManagedIdentityRequest
AzureManagedIdentityResponse
AzureServicePrincipal
CancelRefreshRequest	Cancel refresh
CancelRefreshResponse
CatalogInfo
CatalogsAPI	A catalog is the first layer of Unity Catalog’s three-level namespace.
CloudflareApiToken
ColumnInfo
ColumnMask
ConnectionInfo
ConnectionsAPI	Connections allow for creating a connection to an external data source.
ContinuousUpdateStatus	Detailed status of an online table.
CreateCatalog
CreateConnection
CreateExternalLocation
CreateFunction
CreateFunctionRequest
CreateMetastore
CreateMetastoreAssignment
CreateMonitor
CreateOnlineTableRequest	Online Table information.
CreateRegisteredModelRequest
CreateResponse
CreateSchema
CreateStorageCredential
CreateTableConstraint
CreateVolumeRequestContent
CurrentWorkspaceBindings	Currently assigned workspaces
DatabricksGcpServiceAccountRequest
DatabricksGcpServiceAccountResponse
DeleteAccountMetastoreAssignmentRequest	Delete a metastore assignment
DeleteAccountMetastoreRequest	Delete a metastore
DeleteAccountStorageCredentialRequest	Delete a storage credential
DeleteAliasRequest	Delete a Registered Model Alias
DeleteAliasResponse
DeleteCatalogRequest	Delete a catalog
DeleteConnectionRequest	Delete a connection
DeleteExternalLocationRequest	Delete an external location
DeleteFunctionRequest	Delete a function
DeleteMetastoreRequest	Delete a metastore
DeleteModelVersionRequest	Delete a Model Version
DeleteOnlineTableRequest	Delete an Online Table
DeleteQualityMonitorRequest	Delete a table monitor
DeleteRegisteredModelRequest	Delete a Registered Model
DeleteResponse
DeleteSchemaRequest	Delete a schema
DeleteStorageCredentialRequest	Delete a credential
DeleteTableConstraintRequest	Delete a table constraint
DeleteTableRequest	Delete a table
DeleteVolumeRequest	Delete a Volume
DeltaRuntimePropertiesKvPairs	Properties pertaining to the current state of the delta table as given by the commit server.
Dependency	A dependency of a SQL object.
DependencyList	A list of dependencies.
DisableRequest	Disable a system schema
DisableResponse
EffectivePermissionsList
EffectivePredictiveOptimizationFlag
EffectivePrivilege
EffectivePrivilegeAssignment
EnableRequest	Enable a system schema
EnableResponse
EncryptionDetails	Encryption options that apply to clients connecting to cloud storage.
ExistsRequest	Get boolean reflecting if table exists
ExternalLocationInfo
ExternalLocationsAPI	An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path.
FailedStatus	Detailed status of an online table.
ForeignKeyConstraint
FunctionDependency	A function that is dependent on a SQL object.
FunctionInfo
FunctionParameterInfo
FunctionParameterInfos
FunctionsAPI	Functions implement User-Defined Functions (UDFs) in Unity Catalog.
GetAccountMetastoreAssignmentRequest	Gets the metastore assignment for a workspace
GetAccountMetastoreRequest	Get a metastore
GetAccountStorageCredentialRequest	Gets the named storage credential
GetArtifactAllowlistRequest	Get an artifact allowlist
GetBindingsRequest	Get securable workspace bindings
GetByAliasRequest	Get Model Version By Alias
GetCatalogRequest	Get a catalog
GetConnectionRequest	Get a connection
GetEffectiveRequest	Get effective permissions
GetExternalLocationRequest	Get an external location
GetFunctionRequest	Get a function
GetGrantRequest	Get permissions
GetMetastoreRequest	Get a metastore
GetMetastoreSummaryResponse
GetModelVersionRequest	Get a Model Version
GetOnlineTableRequest	Get an Online Table
GetQualityMonitorRequest	Get a table monitor
GetRefreshRequest	Get refresh
GetRegisteredModelRequest	Get a Registered Model
GetSchemaRequest	Get a schema
GetStorageCredentialRequest	Get a credential
GetTableRequest	Get a table
GetWorkspaceBindingRequest	Get catalog workspace bindings
GrantsAPI	In Unity Catalog, data is secure by default.
ListAccountMetastoreAssignmentsRequest	Get all workspaces assigned to a metastore
ListAccountMetastoreAssignmentsResponse	The list of workspaces to which the given metastore is assigned.
ListAccountStorageCredentialsRequest	Get all storage credentials assigned to a metastore
ListCatalogsRequest	List catalogs
ListCatalogsResponse
ListConnectionsRequest	List connections
ListConnectionsResponse
ListExternalLocationsRequest	List external locations
ListExternalLocationsResponse
ListFunctionsRequest	List functions
ListFunctionsResponse
ListMetastoresResponse
ListModelVersionsRequest	List Model Versions
ListModelVersionsResponse
ListRefreshesRequest	List refreshes
ListRegisteredModelsRequest	List Registered Models
ListRegisteredModelsResponse
ListSchemasRequest	List schemas
ListSchemasResponse
ListStorageCredentialsRequest	List credentials
ListStorageCredentialsResponse
ListSummariesRequest	List table summaries
ListSystemSchemasRequest	List system schemas
ListSystemSchemasResponse
ListTablesRequest	List tables
ListTablesResponse
ListTableSummariesResponse
ListVolumesRequest	List Volumes
ListVolumesResponseContent
MetastoreAssignment
MetastoreInfo
MetastoresAPI	A metastore is the top-level container of objects in Unity Catalog.
ModelVersionInfo
ModelVersionsAPI	Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
MonitorCronSchedule
MonitorDataClassificationConfig
MonitorDestination
MonitorInferenceLog
MonitorInfo
MonitorMetric
MonitorNotifications
MonitorRefreshInfo
MonitorRefreshListResponse
MonitorSnapshot
MonitorTimeSeries
NamedTableConstraint
OnlineTable	Online Table information.
OnlineTablesAPI	Online tables provide lower latency and higher QPS access to data from Delta tables.
OnlineTableSpec	Specification of an online table.
OnlineTableSpecContinuousSchedulingPolicy
OnlineTableSpecTriggeredSchedulingPolicy
OnlineTableStatus	Status of an online table.
PermissionsChange
PermissionsList
PipelineProgress	Progress information of the Online Table data synchronization pipeline.
PrimaryKeyConstraint
PrivilegeAssignment
ProvisioningInfo	Status of an asynchronously provisioned resource.
ProvisioningStatus	Detailed status of an online table.
QualityMonitorsAPI	A monitor computes and monitors data or model quality metrics for a table over time.
ReadVolumeRequest	Get a Volume
RegisteredModelAlias	Registered model alias.
RegisteredModelInfo
RegisteredModelsAPI	Databricks provides a hosted version of MLflow Model Registry in Unity Catalog.
RunRefreshRequest	Queue a metric refresh for a monitor
SchemaInfo
SchemasAPI	A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
SetArtifactAllowlist
SetRegisteredModelAliasRequest
SseEncryptionDetails	Server-Side Encryption properties for clients communicating with AWS s3.
StorageCredentialInfo
StorageCredentialsAPI	A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant.
SystemSchemaInfo
SystemSchemasAPI	A system schema is a schema that lives within the system catalog.
TableConstraint	A table constraint, as defined by *one* of the following fields being set: __primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.
TableConstraintsAPI	Primary key and foreign key constraints encode relationships between fields in tables.
TableDependency	A table that is dependent on a SQL object.
TableExistsResponse
TableInfo
TableRowFilter
TablesAPI	A table resides in the third layer of Unity Catalog’s three-level namespace.
TableSummary
TriggeredUpdateStatus	Detailed status of an online table.
UnassignRequest	Delete an assignment
UnassignResponse
UpdateAssignmentResponse
UpdateCatalog
UpdateConnection
UpdateExternalLocation
UpdateFunction
UpdateMetastore
UpdateMetastoreAssignment
UpdateModelVersionRequest
UpdateMonitor
UpdatePermissions
UpdateRegisteredModelRequest
UpdateResponse
UpdateSchema
UpdateStorageCredential
UpdateTableRequest	Update a table owner.
UpdateVolumeRequestContent
UpdateWorkspaceBindings
UpdateWorkspaceBindingsParameters
ValidateStorageCredential
ValidateStorageCredentialResponse
ValidationResult
VolumeInfo
VolumesAPI	Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and processing files.
WorkspaceBinding
WorkspaceBindingsAPI	A securable in Databricks can be configured as __OPEN__ or __ISOLATED__.
WorkspaceBindingsResponse	Currently assigned workspace bindings

Enum Summary

Enum	Description
ArtifactType	The artifact type
CatalogInfoSecurableKind	Kind of catalog securable.
CatalogType	The type of the catalog.
ColumnTypeName	Name of type (INT, STRUCT, MAP, etc.).
ConnectionInfoSecurableKind	Kind of connection securable.
ConnectionType	The type of connection.
CreateFunctionParameterStyle	Function parameter style.
CreateFunctionRoutineBody	Function language.
CreateFunctionSecurityType	Function security type.
CreateFunctionSqlDataAccess	Function SQL data access.
CredentialType	The type of credential.
DataSourceFormat	Data source format
EffectivePredictiveOptimizationFlagInheritedFromType	The type of the object from which the flag was inherited.
EnablePredictiveOptimization	Whether predictive optimization should be enabled for this object and objects under it.
FunctionInfoParameterStyle	Function parameter style.
FunctionInfoRoutineBody	Function language.
FunctionInfoSecurityType	Function security type.
FunctionInfoSqlDataAccess	Function SQL data access.
FunctionParameterMode	The mode of the function parameter.
FunctionParameterType	The type of function parameter.
GetMetastoreSummaryResponseDeltaSharingScope	The scope of Delta Sharing enabled for the metastore.
IsolationMode	Whether the current securable is accessible from all workspaces or a specific set of workspaces.
MatchType	The artifact pattern matching type
MetastoreInfoDeltaSharingScope	The scope of Delta Sharing enabled for the metastore.
ModelVersionInfoStatus	Current status of the model version.
MonitorCronSchedulePauseStatus	Read only field that indicates whether a schedule is paused or not.
MonitorInferenceLogProblemType	Problem type the model aims to solve.
MonitorInfoStatus	The status of the monitor.
MonitorMetricType	Can only be one of ``"CUSTOM_METRIC_TYPE_AGGREGATE"``, ``"CUSTOM_METRIC_TYPE_DERIVED"``, or ``"CUSTOM_METRIC_TYPE_DRIFT"``.
MonitorRefreshInfoState	The current state of the refresh.
MonitorRefreshInfoTrigger	The method by which the refresh was triggered.
OnlineTableState	The state of an online table.
Privilege
ProvisioningInfoState
SecurableType	The type of Unity Catalog securable
SseEncryptionDetailsAlgorithm	The type of key encryption to use (affects headers from s3 client).
SystemSchemaInfoState	The current state of enablement for the system schema.
TableType
UpdateMetastoreDeltaSharingScope	The scope of Delta Sharing enabled for the metastore.
ValidationResultOperation	The operation tested.
ValidationResultResult	The results of the tested operation.
VolumeType
WorkspaceBindingBindingType