Releases: databricks/databricks-sdk-go
v0.19.0
- Added
ErrNotWorkspaceClient
(#596). - Fix loading of databrickscfg with a password containing a hash (#595).
- Use an operation's request type name if specified (#598).
- Update OpenAPI spec (#600).
API Changes:
- Renamed permissions APIs to no longer include the service name, for example:
GetJobPermissionLevels
->GetPermissionLevels
GetJobPermissions
->GetPermissions
SetJobPermissions
->SetPermissions
UpdateJobPermissions
->UpdatePermissions
- Changed
Create
method for w.Volumes workspace-level service with new required argument order. - Added
SupportsElasticDisk
field for compute.NodeType. - Changed
Create
method for w.Dashboards workspace-level service with new required argument order. - Added w.DashboardWidgets workspace-level service.
- Added w.QueryVisualizations workspace-level service.
- Changed
Name
field for sql.CreateDashboardRequest to be required. - Added
DashboardFiltersEnabled
field for sql.CreateDashboardRequest. - Added
RunAsRole
field for sql.CreateDashboardRequest. - Added
RunAsRole
field for sql.Query. - Added
RunAsRole
field for sql.QueryPostContent. - Removed
DashboardId
field for sql.WidgetOptions. - Changed
Position
field for sql.WidgetOptions to sql.WidgetPosition. - Removed
Text
field for sql.WidgetOptions. - Added
Description
field for sql.WidgetOptions. - Added
Title
field for sql.WidgetOptions. - Added sql.CreateQueryVisualizationRequest.
- Added sql.CreateWidget.
- Added sql.DeleteDashboardWidgetRequest.
- Added sql.DeleteQueryVisualizationRequest.
- Added sql.RunAsRole.
- Added sql.WidgetPosition.
OpenAPI SHA: 09a7fa63d9ae243e5407941f200960ca14d48b07, Date: 2023-09-04
Dependency updates:
- Bump google.golang.org/api from 0.136.0 to 0.138.0 (#587).
v0.18.0
Breaking Changes:
- Added support Files API (application/octet-stream) in OpenAPI Spec (#572). The signatures of
Upload
,Download
andDelete
have changed; these methods now takeUploadRequest
,DownloadRequest
, andDeleteRequest
structures, respectively. Shortcut methods are generated forDownloadByFileName
andDeleteByFileName
for convenience. TheWriteFile
andReadFile
methods are removed. - Propagated Request Headers to client.go (#589). The
Do
method ofClient
now requires an additional parameter for request headers. Add headers to requests using this parameter, or passnil
if no headers are needed.
Breaking API Changes:
- Removed w.SecurableTags workspace-level service and all associated structures.
- Removed w.SubentityTags workspace-level service and all associated structures.
- Renamed
ProvisioningState
field toProvisioningInfo
for catalog.ConnectionInfo. - Changed catalog.ProvisioningState to catalog.ProvisioningInfoState.
- Removed
InstancePoolFleetAttributes
field for compute.CreateInstancePool. - Removed
InstancePoolFleetAttributes
field for compute.EditInstancePool. - Removed compute.FleetLaunchTemplateOverride.
- Removed compute.FleetOnDemandOption.
- Removed compute.FleetOnDemandOptionAllocationStrategy.
- Removed compute.FleetSpotOption.
- Removed compute.FleetSpotOptionAllocationStrategy.
- Removed
InstancePoolFleetAttributes
field for compute.GetInstancePool. - Removed
InstancePoolFleetAttributes
field for compute.InstancePoolAndStats. - Removed compute.InstancePoolFleetAttributes.
- Changed
GetByName
method for w.Experiments workspace-level service to return ml.GetExperimentResponse. - Changed
GetExperiment
method for w.Experiments workspace-level service to return ml.GetExperimentResponse. - Renamed ml.GetExperimentByNameResponse to ml.GetExperimentResponse.
API Changes:
- Changed
List
method for a.AccountStorageCredentials account-level service to return catalog.StorageCredentialInfoList. - Added w.ModelVersions workspace-level service.
- Added w.RegisteredModels workspace-level service.
- Added
BrowseOnly
field for catalog.CatalogInfo. - Added
FullName
field for catalog.CatalogInfo. - Added
ProvisioningInfo
field for catalog.CatalogInfo. - Added
SecurableKind
field for catalog.CatalogInfo. - Added
SecurableType
field for catalog.CatalogInfo. - Added
Options
field for catalog.CreateCatalog. - Added
Options
field for catalog.UpdateCatalog. - Added catalog.CreateRegisteredModelRequest.
- Added catalog.DeleteAliasRequest.
- Added catalog.DeleteModelVersionRequest.
- Added catalog.DeleteRegisteredModelRequest.
- Added catalog.GetByAliasRequest.
- Added catalog.GetModelVersionRequest.
- Added catalog.GetRegisteredModelRequest.
- Added catalog.ListModelVersionsRequest.
- Added catalog.ListModelVersionsResponse.
- Added catalog.ListRegisteredModelsRequest.
- Added catalog.ListRegisteredModelsResponse.
- Added catalog.ModelVersionInfo.
- Added catalog.ModelVersionInfoStatus.
- Added catalog.ProvisioningInfo.
- Added catalog.ProvisioningInfoState.
- Added catalog.RegisteredModelAlias.
- Added catalog.RegisteredModelInfo.
- Added catalog.SetRegisteredModelAliasRequest.
- Added catalog.UpdateModelVersionRequest.
- Added catalog.UpdateRegisteredModelRequest.
- Added
Volumes
field for compute.InitScriptInfo. - Added compute.VolumesStorageInfo.
- Added w.Files workspace-level service.
- Added files.DeleteFileRequest.
- Added files.DownloadRequest.
- Added files.DownloadResponse.
- Added files.UploadRequest.
- Added
CustomTags
field for provisioning.CreateWorkspaceRequest. - Added
CustomTags
field for provisioning.UpdateWorkspaceRequest. - Added
CustomTags
field for [provisioning.Workspace](https://pkg.go.dev/github.com...
v0.17.0
Change Summary
- Introduced Artifact Allowlist, Securable Tags, and Subentity Tags services.
- Introduced DeleteRuns and RestoreRuns methods in the Experiments API.
- Introduced the GetSecret method in the Secrets API.
- Renamed Auto Maintenance to Predictive Optimization.
- Set necessary headers when authenticating via Azure CLI (#584).
New Services:
- Added w.ArtifactAllowlists workspace-level service.
- Added w.SecurableTags workspace-level service.
- Added w.SubentityTags workspace-level service.
- Added catalog.ArtifactAllowlistInfo.
- Added catalog.ArtifactMatcher.
- Added catalog.ArtifactType.
- Added catalog.GetArtifactAllowlistRequest.
- Added catalog.ListSecurableTagsRequest.
- Added catalog.ListSecurableType.
- Added catalog.ListSubentityTagsRequest.
- Added catalog.MatchType.
- Added catalog.SetArtifactAllowlist.
- Added catalog.TagChanges.
- Added catalog.TagKeyValuePair.
- Added catalog.TagSecurable.
- Added catalog.TagSecurableAssignment.
- Added catalog.TagSecurableAssignmentsList.
- Added catalog.TagSubentity.
- Added catalog.TagSubentityAssignmentsList.
- Added catalog.TagsSubentityAssignment.
- Added catalog.UpdateSecurableType.
- Added catalog.UpdateTags.
New APIs:
- Added
DeleteRuns
method for w.Experiments workspace-level service. - Added
RestoreRuns
method for w.Experiments workspace-level service. - Added ml.DeleteRuns.
- Added ml.DeleteRunsResponse.
- Added ml.RestoreRuns.
- Added ml.RestoreRunsResponse.
- Added
GetSecret
method for w.Secrets workspace-level service. - Added workspace.GetSecretRequest.
- Added workspace.GetSecretResponse.
Service Renames:
- Renamed
EffectiveAutoMaintenanceFlag
field toEffectivePredictiveOptimizationFlag
for catalog.CatalogInfo. - Renamed
EnableAutoMaintenance
field toEnablePredictiveOptimization
for catalog.CatalogInfo. - Renamed catalog.EffectiveAutoMaintenanceFlag to catalog.EffectivePredictiveOptimizationFlag.
- Renamed catalog.EffectiveAutoMaintenanceFlagInheritedFromType to catalog.EffectivePredictiveOptimizationFlagInheritedFromType.
- Renamed catalog.EnableAutoMaintenance to catalog.EnablePredictiveOptimization.
- Renamed
EffectiveAutoMaintenanceFlag
field for catalog.SchemaInfo toEffectivePredictiveOptimizationFlag
field for
catalog.SchemaInfo. - Renamed
EnableAutoMaintenance
field for catalog.SchemaInfo toEnablePredictiveOptimization
field for catalog.SchemaInfo. - Renamed
EffectiveAutoMaintenanceFlag
field for catalog.TableInfo toEffectivePredictiveOptimizationFlag
field for catalog.TableInfo. - Renamed
EnableAutoMaintenance
field for catalog.TableInfo toEnablePredictiveOptimization
field for catalog.TableInfo.
OpenAPI SHA: beff621d7b3e1d59244e2e34fc53a496f310e130, Date: 2023-08-17
v0.16.0
API changes
- Changed
Create
method for a.AccountStorageCredentials account-level service to return catalog.AccountsStorageCredentialInfo. - Changed
Get
method for a.AccountStorageCredentials account-level service to return catalog.AccountsStorageCredentialInfo. - Changed
Update
method for a.AccountStorageCredentials account-level service to return catalog.AccountsStorageCredentialInfo. - Changed
Create
method for w.Connections workspace-level service with new required argument order. - Changed
Update
method for w.Connections workspace-level service with new required argument order. - Removed
OptionsKvpairs
field for catalog.ConnectionInfo. - Removed
PropertiesKvpairs
field for catalog.ConnectionInfo. - Added
Options
field for catalog.ConnectionInfo. - Added
Properties
field for catalog.ConnectionInfo. - Added
ProvisioningState
field for catalog.ConnectionInfo. - Added
SecurableKind
field for catalog.ConnectionInfo. - Added
SecurableType
field for catalog.ConnectionInfo. - Removed
OptionsKvpairs
field for catalog.CreateConnection. - Removed
PropertiesKvpairs
field for catalog.CreateConnection. - Added
Options
field for catalog.CreateConnection. - Added
Properties
field for catalog.CreateConnection. - Changed
Algorithm
field for catalog.SseEncryptionDetails
to no longer be required. - Removed
OptionsKvpairs
field for catalog.UpdateConnection. - Added
Options
field for catalog.UpdateConnection. - Added catalog.AccountsStorageCredentialInfo.
- Added catalog.ConnectionInfoSecurableKind.
- Added catalog.ProvisioningState.
- Added
DataSecurityMode
field for compute.CreateCluster. - Added
DockerImage
field for compute.CreateCluster. - Added
SingleUserName
field for compute.CreateCluster. - Removed
Schema
field for iam.PartialUpdate. - Added
Schemas
field for iam.PartialUpdate.
OpenAPI SHA: 1e3533f94335f0e6c5d9262bc1fea95b3ddcb0e1, Date: 2023-08-11
Other changes
- Added ability to generate flat names (#568).
Dependency updates
v0.15.0
To simplify documentation and management of object permissions, this release features a major reorganization of how permissions APIs are structured in the SDK. Rather than using a single Permissions.Get()
API for all services, each service supporting permissions has its own permissions APIs. Follow these steps to migrate to the current SDK:
- Change
w.Permissions.Get()
andw.Permissions.GetByRequestObjectIdAndRequestObjectType()
tow.<Service>.Get<Service>Permissions()
- Change
w.Permissions.GetPermissionLevels()
tow.<Service>.GetServicePermissionLevels()
- Change
w.Permissions.Set()
tow.<Service>.Set<Service>Permissions()
- Change
w.Permissions.Update()
tow.<Service>.Update<Service>Permissions()
API Changes:
- Added
GetClusterPolicyPermissionLevels
method for w.ClusterPolicies workspace-level service. - Added
GetClusterPolicyPermissions
method for w.ClusterPolicies workspace-level service. - Added
SetClusterPolicyPermissions
method for w.ClusterPolicies workspace-level service. - Added
UpdateClusterPolicyPermissions
method for w.ClusterPolicies workspace-level service. - Added
GetClusterPermissionLevels
method for w.Clusters workspace-level service. - Added
GetClusterPermissions
method for w.Clusters workspace-level service. - Added
SetClusterPermissions
method for w.Clusters workspace-level service. - Added
UpdateClusterPermissions
method for w.Clusters workspace-level service. - Added
GetInstancePoolPermissionLevels
method for w.InstancePools workspace-level service. - Added
GetInstancePoolPermissions
method for w.InstancePools workspace-level service. - Added
SetInstancePoolPermissions
method for w.InstancePools workspace-level service. - Added
UpdateInstancePoolPermissions
method for w.InstancePools workspace-level service. - Added compute.ClusterAccessControlRequest.
- Added compute.ClusterAccessControlResponse.
- Added compute.ClusterPermission.
- Added compute.ClusterPermissionLevel.
- Added compute.ClusterPermissions.
- Added compute.ClusterPermissionsDescription.
- Added compute.ClusterPermissionsRequest.
- Added compute.ClusterPolicyAccessControlRequest.
- Added compute.ClusterPolicyAccessControlResponse.
- Added compute.ClusterPolicyPermission.
- Added compute.ClusterPolicyPermissionLevel.
- Added compute.ClusterPolicyPermissions.
- Added compute.ClusterPolicyPermissionsDescription.
- Added compute.ClusterPolicyPermissionsRequest.
- Added compute.GetClusterPermissionLevelsRequest.
- Added compute.GetClusterPermissionLevelsResponse.
- Added compute.GetClusterPermissionsRequest.
- Added compute.GetClusterPolicyPermissionLevelsRequest.
- Added compute.GetClusterPolicyPermissionLevelsResponse.
- Added compute.GetClusterPolicyPermissionsRequest.
- Added compute.GetInstancePoolPermissionLevelsRequest.
- Added compute.GetInstancePoolPermissionLevelsResponse.
- Added compute.GetInstancePoolPermissionsRequest.
- Added compute.InstancePoolAccessControlRequest.
- Added compute.InstancePoolAccessControlResponse.
- Added compute.InstancePoolPermission.
- Added compute.InstancePoolPermissionLevel.
- Added compute.InstancePoolPermissions.
- Added compute.InstancePoolPermissionsDescription.
- Added compute.InstancePoolPermissionsRequest.
- Changed
Set
method for w.Permissions workspace-level service to start returning iam.ObjectPermissions. - Changed
Update
method for w.Permissions workspace-level service to start returning iam.ObjectPermissions. - Added
GetPasswordPermissionLevels
method for w.Users workspace-level service. - Added
GetPasswordPermissions
method for w.Users workspace-level service. - Added
SetPasswordPermissions
method for w.Users workspace-level service. - Added
UpdatePasswordPermissions
method for w.Users workspace-level service. - Added
DisplayName
field for iam.AccessControlResponse. - Changed
Roles
field for iam.GetAssignableRolesForResourceResponse to iam.RoleList. - Added iam.GetPasswordPermissionLevelsResponse.
- Added iam.PasswordAccessControlRequest.
- Added iam.PasswordAccessControlResponse.
- Added iam.PasswordPermission.
- Added [iam.PasswordPermissionLevel](https://pkg.go.dev/github....
v0.14.1
v0.14.0
- Fixed names of keyword arguments in examples (#560).
API Changes:
- Changed
Create
method for a.AccountMetastoreAssignments account-level service to no longer return catalog.CreateMetastoreAssignmentsResponseItemList. - Added
ConnectionName
field for catalog.CreateCatalog. - Added
AccessPoint
field for catalog.CreateExternalLocation. - Added
EncryptionDetails
field for catalog.CreateExternalLocation. - Removed catalog.CreateMetastoreAssignmentsResponseItem.
- Added
AccessPoint
field for catalog.ExternalLocationInfo. - Added
EncryptionDetails
field for catalog.ExternalLocationInfo. - Added
AccessPoint
field for catalog.TableInfo. - Added
EncryptionDetails
field for catalog.TableInfo. - Added
AccessPoint
field for catalog.UpdateExternalLocation. - Added
EncryptionDetails
field for catalog.UpdateExternalLocation. - Added
AccessPoint
field for catalog.VolumeInfo. - Added
EncryptionDetails
field for catalog.VolumeInfo. - Added catalog.EncryptionDetails.
- Added catalog.SseEncryptionDetails.
- Added catalog.SseEncryptionDetailsAlgorithm.
- Added a.AccountNetworkPolicy account-level service.
- Added settings.AccountNetworkPolicyMessage.
- Added settings.DeleteAccountNetworkPolicyRequest.
- Added settings.DeleteAccountNetworkPolicyResponse.
- Added settings.ReadAccountNetworkPolicyRequest.
- Added settings.UpdateAccountNetworkPolicyRequest.
OpenAPI SHA: fbdd0fa3e83fed2c798a58d376529bdb1285b915, Date: 2023-07-26
v0.13.0
- Add issue templates (#539).
- Added HasRequiredNonBodyField method (#536).
- Make Azure MSI auth account compatible (#544).
- Refactor Handling of Name<->ID Mapping in OpenAPI Generator (#547).
- Regenerate Go SDK from current OpenAPI Specification (#549).
- Parse Camel Case and Pascal Case Enum Values (#550).
- Prepare for auto-releaser infra (#554).
- Added SCIM Patch Acceptance Tests (#540).
API Changes:
- Removed
Maintenance
method for w.Metastores workspace-level service. - Added
EnableOptimization
method for w.Metastores workspace-level service. - Added
Update
method for w.Tables workspace-level service. - Added
Force
field for catalog.DeleteAccountMetastoreRequest. - Added
Force
field for catalog.DeleteAccountStorageCredentialRequest. - Removed catalog.UpdateAutoMaintenance.
- Removed catalog.UpdateAutoMaintenanceResponse.
- Added catalog.UpdatePredictiveOptimization.
- Added catalog.UpdatePredictiveOptimizationResponse.
- Added catalog.UpdateTableRequest.
- Added
Schema
field for iam.PartialUpdate. - Added iam.PatchSchema.
- Added
TriggerInfo
field for jobs.BaseRun. - Added
Health
field for jobs.CreateJob. - Added
JobSource
field for jobs.GitSource. - Added
OnDurationWarningThresholdExceeded
field for jobs.JobEmailNotifications. - Added
Health
field for jobs.JobSettings. - Added
TriggerInfo
field for jobs.Run. - Added
RunJobOutput
field for jobs.RunOutput. - Added
RunJobTask
field for jobs.RunTask. - Added
EmailNotifications
field for jobs.SubmitRun. - Added
Health
field for jobs.SubmitRun. - Added
EmailNotifications
field for jobs.SubmitTask. - Added
Health
field for jobs.SubmitTask. - Added
NotificationSettings
field for jobs.SubmitTask. - Added
Health
field for jobs.Task. - Added
RunJobTask
field for jobs.Task. - Added
OnDurationWarningThresholdExceeded
field for jobs.TaskEmailNotifications. - Added
OnDurationWarningThresholdExceeded
field for jobs.WebhookNotifications. - Added jobs.JobSource.
- Added jobs.JobSourceDirtyState.
- Added jobs.JobsHealthMetric.
- Added jobs.JobsHealthOperator.
- Added jobs.JobsHealthRule.
- Added jobs.JobsHealthRules.
- Added jobs.RunJobOutput.
- Added jobs.RunJobTask.
- Added jobs.TriggerInfo.
- Added jobs.WebhookNotificationsOnDurationWarningThresholdExceededItem.
- Removed
Whl
field for pipelines.PipelineLibrary. - Changed
DeletePersonalComputeSetting
method for a.AccountSettings account-level service with new required argument order. - Changed
ReadPersonalComputeSetting
method for a.AccountSettings account-level service with new required argument order. - Changed
Etag
field for settings.DeletePersonalComputeSettingRequest to be required. - Changed
Etag
field for settings.ReadPersonalComputeSettingRequest to be required. - Added w.CleanRooms workspace-level service.
- Added sharing.CentralCleanRoomInfo.
- Added sharing.CleanRoomAssetInfo.
- Added sharing.CleanRoomCatalog.
- Added sharing.CleanRoomCatalogUpdate.
- Added sharing.CleanRoomCollaboratorInfo.
- Added sharing.CleanRoomInfo.
- Added sharing.CleanRoomNotebookInfo.
- Added sharing.CleanRoomTableInfo.
- Added sharing.ColumnInfo.
- Added sharing.ColumnMask.
- Added sharing.ColumnTypeName.
- Added sharing.CreateCleanRoom.
- Added sharing.DeleteCleanRoomRequest.
- Added sharing.GetCleanRoomRequest.
- Added sharing.ListCleanRoomsResponse.
- Added sharing.UpdateCleanRoom.
- Changed
Query
field for sql.Alert to sql.AlertQuery. - Changed
Value
field for [sql.AlertOptions](https://pkg.go.dev/github.com/databr...
v0.12.0
v0.11.0
- Regenerated from OpenAPI spec (#527). Includes bugfixes for System Tables.
- Support accounts-dod as account endpoint (#530).
Breaking API Changes:
- Renamed compute.ClusterInfo to compute.ClusterDetails
- Renamed compue.BaseClusterInfo to compute.ClusterSpec
- Renamed jobs.RunSubmitTaskSettings to jobs.SubmitTask
- Renamed jobs.JobTaskSettings to jobs.Task
- Renamed jobs.CreateJobFormat to jobs.Format
- Renamed jobs.JobsWebhookNotifications to jobs.WebhookNotifications
- Renamed jobs.CronSchedulePauseStatus to jobs.PauseStatus
- Renamed jobs.FileArrivalTriggerSettings to jobs.FileArrivalTriggerConfiguration
- Renamed jobs.GitSourceGitProvider to jobs.GitProvider
- Consolidated jobs.NotebookTaskSource, jobs.SparkPythonTaskSource to jobs.Source
- Consolidated jobs.JobWebhookNotificationsOnFailureItem, jobs.JobWebhookNotificationsOnStartItem, jobs.JobWebhookNotificationsOnSuccessItem to jobs.Webhook
- Renamed jobs.TaskDependenciesItem to job.TaskDependency
- jobs.SparkSubmitTask.Widgets changed from *SqlDashboardWidgetOutput to []SqlDashboardWidgetOutput
- (a *SystemSchemasAPI) DisableByMetastoreIdAndSchemaName changed from func(context.Context, string, string) error to func(context.Context, string, DisableSchemaName) error
- (a *SystemSchemasAPI) Enable changed from func(context.Context) error to func(context.Context, EnableRequest) error
- catalog.CatalogInfo.OptionsKvpairs changed from *OptionsKvPairs to map[string]string
- catalog.CreateConnection.OptionsKvpairs changed from *OptionsKvPairs to map[string]string
- catalog.UpdateConnection.OptionsKvpairs changed from OptionsKvPairs to map[string]string
- catalog.DisableRequest.SchemaName changed from string to DisableSchemaName
- catalog.OptionsKvPairs removed
- catalog.SystemSchemaInfoStateDisableinitialized renamed to catalog.SystemSchemaInfoStateDisabledInitialized
- catalog.SystemSchemaInfoStateEnabledcompleted renamed to catalog.SystemSchemaInfoStateEnabledCompleted
- catalog.SystemSchemaInfoStateEnabledinitialized renamed to catalog.SystemSchemaInfoStateEnabledInitialized
- settings.ReadPersonalComputeSettingsResponse renamed to settings.PersonalComputeSetting
- workpace.CreateScope.KeyvaultMetadata removed
Other API Changes:
- catalog.CatalogInfo.ConnectionName added
- catalog.CatalogInfo.Options added
- catalog.DisableSchemaName added
- catalog.EnableRequest added
- catalog.PrivilegeUseMarketplaceAssets added
- compute.ClusterEvent added
- compute.ComputeSpec added
- compute.ComputeSpecKind added
- jobs.ConditionTask added
- jobs.ConditionTaskOp added
- jobs.CreateJob.Compute added
- jobs.JobCompute added
- jobs.JobSettings.Compute added
- jobs.RunConditionTask added
- jobs.RunOutput.ConditionTask added
- jobs.RunTask.ConditionTask added
- serving.ServedModelInput.EnvironmentVars added
- serving.ServedModelOutput.EnvironmentVars added
- settings.DeletePersonalComputeSetting added
- settings.UpdatePersonalComputeSetting added
- sharing.PrivilegeUseMarketplaceAssets added
- workspace.CreateScope.BackendAzureKeyVault added
Full Changelog: v0.10.1...v0.11.0