databricks-sdk 0.48.0__tar.gz → 0.50.0__tar.gz

{databricks_sdk-0.48.0 → databricks_sdk-0.50.0}/CHANGELOG.md

@@ -1,5 +1,72 @@
 # Version changelog
 
+## Release v0.50.0
+
+### API Changes
+* Added [w.enable_export_notebook](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/settings/enable_export_notebook.html) workspace-level service, [w.enable_notebook_table_clipboard](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/settings/enable_notebook_table_clipboard.html) workspace-level service and [w.enable_results_downloading](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/settings/settings/enable_results_downloading.html) workspace-level service.
+* Added `get_credentials_for_trace_data_download()` and `get_credentials_for_trace_data_upload()` methods for [w.experiments](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/ml/experiments.html) workspace-level service.
+* Added `get_download_full_query_result()` method for [w.genie](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/genie.html) workspace-level service.
+* Added `get_published_dashboard_token_info()` method for [w.lakeview_embedded](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/lakeview_embedded.html) workspace-level service.
+* Added `binding_workspace_ids` field for `databricks.sdk.service.billing.BudgetPolicy`.
+* Added `download_id` field for `databricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse`.
+* Added `dashboard_output` field for `databricks.sdk.service.jobs.RunOutput`.
+* Added `dashboard_task` and `power_bi_task` fields for `databricks.sdk.service.jobs.RunTask`.
+* Added `dashboard_task` and `power_bi_task` fields for `databricks.sdk.service.jobs.SubmitTask`.
+* Added `dashboard_task` and `power_bi_task` fields for `databricks.sdk.service.jobs.Task`.
+* Added `include_features` field for `databricks.sdk.service.ml.CreateForecastingExperimentRequest`.
+* Added `models` field for `databricks.sdk.service.ml.LogInputs`.
+* Added `dataset_digest`, `dataset_name` and `model_id` fields for `databricks.sdk.service.ml.LogMetric`.
+* Added `dataset_digest`, `dataset_name`, `model_id` and `run_id` fields for `databricks.sdk.service.ml.Metric`.
+* Added `model_inputs` field for `databricks.sdk.service.ml.RunInputs`.
+* Added `client_application` field for `databricks.sdk.service.sql.QueryInfo`.
+* Added `geography` and `geometry` enum values for `databricks.sdk.service.catalog.ColumnTypeName`.
+* Added `allocation_timeout_no_healthy_and_warmed_up_clusters`, `docker_container_creation_exception`, `docker_image_too_large_for_instance_exception` and `docker_invalid_os_exception` enum values for `databricks.sdk.service.compute.TerminationReasonCode`.
+* Added `standard` enum value for `databricks.sdk.service.jobs.PerformanceTarget`.
+* Added `can_view` enum value for `databricks.sdk.service.sql.WarehousePermissionLevel`.
+* [Breaking] Changed `generate_download_full_query_result()` method for [w.genie](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/genie.html) workspace-level service . Method path has changed.
+* [Breaking] Changed waiter for [CommandExecutionAPI.create](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/command_execution.html#databricks.sdk.service.compute.CommandExecutionAPI.create) method.
+* [Breaking] Changed waiter for [CommandExecutionAPI.execute](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/command_execution.html#databricks.sdk.service.compute.CommandExecutionAPI.execute) method.
+* [Breaking] Removed `error`, `status` and `transient_statement_id` fields for `databricks.sdk.service.dashboards.GenieGenerateDownloadFullQueryResultResponse`.
+* [Breaking] Removed `balanced` and `cost_optimized` enum values for `databricks.sdk.service.jobs.PerformanceTarget`.
+* [Breaking] Removed [PipelinesAPI.wait_get_pipeline_running](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/pipelines/pipelines.html#databricks.sdk.service.pipelines.PipelinesAPI.wait_get_pipeline_running) method.
+
+
+## Release v0.49.0
+
+### API Changes
+* Added `generate_download_full_query_result()` method for [w.genie](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/dashboards/genie.html) workspace-level service.
+* Added `effective_user_api_scopes`, `oauth2_app_client_id`, `oauth2_app_integration_id` and `user_api_scopes` fields for `databricks.sdk.service.apps.App`.
+* Added `abfss`, `dbfs`, `error_message`, `execution_duration_seconds`, `file`, `gcs`, `s3`, `status`, `volumes` and `workspace` fields for `databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails`.
+* [Breaking] Added `forecast_granularity` field for `databricks.sdk.service.ml.CreateForecastingExperimentRequest`.
+* Added `jwks_uri` field for `databricks.sdk.service.oauth2.OidcFederationPolicy`.
+* Added `event_log` field for `databricks.sdk.service.pipelines.CreatePipeline`.
+* Added `event_log` field for `databricks.sdk.service.pipelines.EditPipeline`.
+* Added `event_log` field for `databricks.sdk.service.pipelines.PipelineSpec`.
+* Added `fallback_config` field for `databricks.sdk.service.serving.AiGatewayConfig`.
+* Added `custom_provider_config` field for `databricks.sdk.service.serving.ExternalModel`.
+* Added `fallback_config` field for `databricks.sdk.service.serving.PutAiGatewayRequest`.
+* Added `fallback_config` field for `databricks.sdk.service.serving.PutAiGatewayResponse`.
+* Added `aliases`, `comment`, `data_type`, `dependency_list`, `full_data_type`, `id`, `input_params`, `name`, `properties`, `routine_definition`, `schema`, `securable_kind`, `share`, `share_id`, `storage_location` and `tags` fields for `databricks.sdk.service.sharing.DeltaSharingFunction`.
+* Added `query_source` field for `databricks.sdk.service.sql.QueryInfo`.
+* Added `foreign_catalog` enum value for `databricks.sdk.service.catalog.CatalogType`.
+* Added `browse` enum value for `databricks.sdk.service.catalog.Privilege`.
+* Added `access_token_failure`, `allocation_timeout`, `allocation_timeout_node_daemon_not_ready`, `allocation_timeout_no_healthy_clusters`, `allocation_timeout_no_matched_clusters`, `allocation_timeout_no_ready_clusters`, `allocation_timeout_no_unallocated_clusters`, `allocation_timeout_no_warmed_up_clusters`, `aws_inaccessible_kms_key_failure`, `aws_instance_profile_update_failure`, `aws_invalid_key_pair`, `aws_invalid_kms_key_state`, `aws_resource_quota_exceeded`, `azure_packed_deployment_partial_failure`, `bootstrap_timeout_due_to_misconfig`, `budget_policy_limit_enforcement_activated`, `budget_policy_resolution_failure`, `cloud_account_setup_failure`, `cloud_operation_cancelled`, `cloud_provider_instance_not_launched`, `cloud_provider_launch_failure_due_to_misconfig`, `cloud_provider_resource_stockout_due_to_misconfig`, `cluster_operation_throttled`, `cluster_operation_timeout`, `control_plane_request_failure_due_to_misconfig`, `data_access_config_changed`, `disaster_recovery_replication`, `driver_eviction`, `driver_launch_timeout`, `driver_node_unreachable`, `driver_out_of_disk`, `driver_out_of_memory`, `driver_pod_creation_failure`, `driver_unexpected_failure`, `dynamic_spark_conf_size_exceeded`, `eos_spark_image`, `executor_pod_unscheduled`, `gcp_api_rate_quota_exceeded`, `gcp_forbidden`, `gcp_iam_timeout`, `gcp_inaccessible_kms_key_failure`, `gcp_insufficient_capacity`, `gcp_ip_space_exhausted`, `gcp_kms_key_permission_denied`, `gcp_not_found`, `gcp_resource_quota_exceeded`, `gcp_service_account_access_denied`, `gcp_service_account_not_found`, `gcp_subnet_not_ready`, `gcp_trusted_image_projects_violated`, `gke_based_cluster_termination`, `init_container_not_finished`, `instance_pool_max_capacity_reached`, `instance_pool_not_found`, `instance_unreachable_due_to_misconfig`, `internal_capacity_failure`, `invalid_aws_parameter`, `invalid_instance_placement_protocol`, `invalid_worker_image_failure`, `in_penalty_box`, `lazy_allocation_timeout`, `maintenance_mode`, `netvisor_setup_timeout`, `no_matched_k8s`, `no_matched_k8s_testing_tag`, `pod_assignment_failure`, `pod_scheduling_failure`, `resource_usage_blocked`, `secret_creation_failure`, `serverless_long_running_terminated`, `spark_image_download_throttled`, `spark_image_not_found`, `ssh_bootstrap_failure`, `storage_download_failure_due_to_misconfig`, `storage_download_failure_slow`, `storage_download_failure_throttled`, `unexpected_pod_recreation`, `user_initiated_vm_termination` and `workspace_update` enum values for `databricks.sdk.service.compute.TerminationReasonCode`.
+* Added `generated_sql_query_too_long_exception` and `missing_sql_query_exception` enum values for `databricks.sdk.service.dashboards.MessageErrorType`.
+* Added `balanced` enum value for `databricks.sdk.service.jobs.PerformanceTarget`.
+* Added `listing_resource` enum value for `databricks.sdk.service.marketplace.FileParentType`.
+* Added `app` enum value for `databricks.sdk.service.marketplace.MarketplaceFileType`.
+* Added `custom` enum value for `databricks.sdk.service.serving.ExternalModelProvider`.
+* Added `arclight_multi_tenant_azure_exchange_token` and `arclight_multi_tenant_azure_exchange_token_with_user_delegation_key` enum values for `databricks.sdk.service.settings.TokenType`.
+* [Breaking] Changed `create_experiment()` method for [w.forecasting](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/ml/forecasting.html) workspace-level service with new required argument order.
+* Changed `instance_type_id` field for `databricks.sdk.service.compute.NodeInstanceType` to be required.
+* Changed `category` field for `databricks.sdk.service.compute.NodeType` to be required.
+* [Breaking] Changed `functions` field for `databricks.sdk.service.sharing.ListProviderShareAssetsResponse` to type `databricks.sdk.service.sharing.DeltaSharingFunctionList` dataclass.
+* [Breaking] Removed `execution_details` and `script` fields for `databricks.sdk.service.compute.InitScriptInfoAndExecutionDetails`.
+* [Breaking] Removed `supports_elastic_disk` field for `databricks.sdk.service.compute.NodeType`.
+* [Breaking] Removed `data_granularity_quantity` and `data_granularity_unit` fields for `databricks.sdk.service.ml.CreateForecastingExperimentRequest`.
+* [Breaking] Removed `aliases`, `comment`, `data_type`, `dependency_list`, `full_data_type`, `id`, `input_params`, `name`, `properties`, `routine_definition`, `schema`, `securable_kind`, `share`, `share_id`, `storage_location` and `tags` fields for `databricks.sdk.service.sharing.Function`.
+
+
 ## Release v0.48.0
 
 ### API Changes

{databricks_sdk-0.48.0 → databricks_sdk-0.50.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: databricks-sdk
-Version: 0.48.0
+Version: 0.50.0
 Summary: Databricks SDK for Python (Beta)
 Project-URL: Documentation, https://databricks-sdk-py.readthedocs.io
 Keywords: databricks,sdk

{databricks_sdk-0.48.0 → databricks_sdk-0.50.0}/databricks/sdk/__init__.py

@@ -86,9 +86,11 @@ from databricks.sdk.service.settings import (
     AibiDashboardEmbeddingApprovedDomainsAPI, AutomaticClusterUpdateAPI,
     ComplianceSecurityProfileAPI, CredentialsManagerAPI,
     CspEnablementAccountAPI, DefaultNamespaceAPI, DisableLegacyAccessAPI,
-    DisableLegacyDbfsAPI, DisableLegacyFeaturesAPI, EnableIpAccessListsAPI,
-    EnhancedSecurityMonitoringAPI, EsmEnablementAccountAPI, IpAccessListsAPI,
-    NetworkConnectivityAPI, NotificationDestinationsAPI, PersonalComputeAPI,
+    DisableLegacyDbfsAPI, DisableLegacyFeaturesAPI, EnableExportNotebookAPI,
+    EnableIpAccessListsAPI, EnableNotebookTableClipboardAPI,
+    EnableResultsDownloadingAPI, EnhancedSecurityMonitoringAPI,
+    EsmEnablementAccountAPI, IpAccessListsAPI, NetworkConnectivityAPI,
+    NotificationDestinationsAPI, PersonalComputeAPI,
     RestrictWorkspaceAdminsAPI, SettingsAPI, TokenManagementAPI, TokensAPI,
     WorkspaceConfAPI)
 from databricks.sdk.service.sharing import (ProvidersAPI,

{databricks_sdk-0.48.0 → databricks_sdk-0.50.0}/databricks/sdk/service/apps.py

@@ -50,9 +50,16 @@ class App:
 
     effective_budget_policy_id: Optional[str] = None
 
+    effective_user_api_scopes: Optional[List[str]] = None
+    """The effective api scopes granted to the user access token."""
+
     id: Optional[str] = None
     """The unique identifier of the app."""
 
+    oauth2_app_client_id: Optional[str] = None
+
+    oauth2_app_integration_id: Optional[str] = None
+
     pending_deployment: Optional[AppDeployment] = None
     """The pending deployment of the app. A deployment is considered pending when it is being prepared
     for deployment to the app compute."""
@@ -75,6 +82,8 @@ class App:
     url: Optional[str] = None
     """The URL of the app once it is deployed."""
 
+    user_api_scopes: Optional[List[str]] = None
+
     def as_dict(self) -> dict:
         """Serializes the App into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -96,10 +105,16 @@ class App:
             body["description"] = self.description
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_user_api_scopes:
+            body["effective_user_api_scopes"] = [v for v in self.effective_user_api_scopes]
         if self.id is not None:
             body["id"] = self.id
         if self.name is not None:
             body["name"] = self.name
+        if self.oauth2_app_client_id is not None:
+            body["oauth2_app_client_id"] = self.oauth2_app_client_id
+        if self.oauth2_app_integration_id is not None:
+            body["oauth2_app_integration_id"] = self.oauth2_app_integration_id
         if self.pending_deployment:
             body["pending_deployment"] = self.pending_deployment.as_dict()
         if self.resources:
@@ -116,6 +131,8 @@ class App:
             body["updater"] = self.updater
         if self.url is not None:
             body["url"] = self.url
+        if self.user_api_scopes:
+            body["user_api_scopes"] = [v for v in self.user_api_scopes]
         return body
 
     def as_shallow_dict(self) -> dict:
@@ -139,10 +156,16 @@ class App:
             body["description"] = self.description
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_user_api_scopes:
+            body["effective_user_api_scopes"] = self.effective_user_api_scopes
         if self.id is not None:
             body["id"] = self.id
         if self.name is not None:
             body["name"] = self.name
+        if self.oauth2_app_client_id is not None:
+            body["oauth2_app_client_id"] = self.oauth2_app_client_id
+        if self.oauth2_app_integration_id is not None:
+            body["oauth2_app_integration_id"] = self.oauth2_app_integration_id
         if self.pending_deployment:
             body["pending_deployment"] = self.pending_deployment
         if self.resources:
@@ -159,6 +182,8 @@ class App:
             body["updater"] = self.updater
         if self.url is not None:
             body["url"] = self.url
+        if self.user_api_scopes:
+            body["user_api_scopes"] = self.user_api_scopes
         return body
 
     @classmethod
@@ -174,8 +199,11 @@ class App:
             default_source_code_path=d.get("default_source_code_path", None),
             description=d.get("description", None),
             effective_budget_policy_id=d.get("effective_budget_policy_id", None),
+            effective_user_api_scopes=d.get("effective_user_api_scopes", None),
             id=d.get("id", None),
             name=d.get("name", None),
+            oauth2_app_client_id=d.get("oauth2_app_client_id", None),
+            oauth2_app_integration_id=d.get("oauth2_app_integration_id", None),
             pending_deployment=_from_dict(d, "pending_deployment", AppDeployment),
             resources=_repeated_dict(d, "resources", AppResource),
             service_principal_client_id=d.get("service_principal_client_id", None),
@@ -184,6 +212,7 @@ class App:
             update_time=d.get("update_time", None),
             updater=d.get("updater", None),
             url=d.get("url", None),
+            user_api_scopes=d.get("user_api_scopes", None),
         )
 
 

{databricks_sdk-0.48.0 → databricks_sdk-0.50.0}/databricks/sdk/service/billing.py

@@ -364,6 +364,10 @@ class BudgetConfigurationFilterWorkspaceIdClause:
 class BudgetPolicy:
     """Contains the BudgetPolicy details."""
 
+    binding_workspace_ids: Optional[List[int]] = None
+    """List of workspaces that this budget policy will be exclusively bound to. An empty binding
+    implies that this budget policy is open to any workspace in the account."""
+
     custom_tags: Optional[List[compute.CustomPolicyTag]] = None
     """A list of tags defined by the customer. At most 20 entries are allowed per policy."""
 
@@ -372,11 +376,14 @@ class BudgetPolicy:
 
     policy_name: Optional[str] = None
     """The name of the policy. - Must be unique among active policies. - Can contain only characters
-    from the ISO 8859-1 (latin1) set."""
+    from the ISO 8859-1 (latin1) set. - Can't start with reserved keywords such as
+    `databricks:default-policy`."""
 
     def as_dict(self) -> dict:
         """Serializes the BudgetPolicy into a dictionary suitable for use as a JSON request body."""
         body = {}
+        if self.binding_workspace_ids:
+            body["binding_workspace_ids"] = [v for v in self.binding_workspace_ids]
         if self.custom_tags:
             body["custom_tags"] = [v.as_dict() for v in self.custom_tags]
         if self.policy_id is not None:
@@ -388,6 +395,8 @@ class BudgetPolicy:
     def as_shallow_dict(self) -> dict:
         """Serializes the BudgetPolicy into a shallow dictionary of its immediate attributes."""
         body = {}
+        if self.binding_workspace_ids:
+            body["binding_workspace_ids"] = self.binding_workspace_ids
         if self.custom_tags:
             body["custom_tags"] = self.custom_tags
         if self.policy_id is not None:
@@ -400,6 +409,7 @@ class BudgetPolicy:
     def from_dict(cls, d: Dict[str, Any]) -> BudgetPolicy:
         """Deserializes the BudgetPolicy from a dictionary."""
         return cls(
+            binding_workspace_ids=d.get("binding_workspace_ids", None),
             custom_tags=_repeated_dict(d, "custom_tags", compute.CustomPolicyTag),
             policy_id=d.get("policy_id", None),
             policy_name=d.get("policy_name", None),

{databricks_sdk-0.48.0 → databricks_sdk-0.50.0}/databricks/sdk/service/catalog.py

@@ -1065,6 +1065,7 @@ class CatalogType(Enum):
     """The type of the catalog."""
 
     DELTASHARING_CATALOG = "DELTASHARING_CATALOG"
+    FOREIGN_CATALOG = "FOREIGN_CATALOG"
     MANAGED_CATALOG = "MANAGED_CATALOG"
     SYSTEM_CATALOG = "SYSTEM_CATALOG"
 
@@ -1270,6 +1271,8 @@ class ColumnTypeName(Enum):
     DECIMAL = "DECIMAL"
     DOUBLE = "DOUBLE"
     FLOAT = "FLOAT"
+    GEOGRAPHY = "GEOGRAPHY"
+    GEOMETRY = "GEOMETRY"
     INT = "INT"
     INTERVAL = "INTERVAL"
     LONG = "LONG"
@@ -2591,6 +2594,11 @@ class CreateVolumeRequestContent:
     """The name of the volume"""
 
     volume_type: VolumeType
+    """The type of the volume. An external volume is located in the specified external location. A
+    managed volume is located in the default location which is specified by the parent schema, or
+    the parent catalog, or the Metastore. [Learn more]
+    
+    [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external"""
 
     comment: Optional[str] = None
     """The comment attached to the volume"""
@@ -6664,6 +6672,7 @@ class Privilege(Enum):
     ACCESS = "ACCESS"
     ALL_PRIVILEGES = "ALL_PRIVILEGES"
     APPLY_TAG = "APPLY_TAG"
+    BROWSE = "BROWSE"
     CREATE = "CREATE"
     CREATE_CATALOG = "CREATE_CATALOG"
     CREATE_CONNECTION = "CREATE_CONNECTION"
@@ -9471,6 +9480,8 @@ class UpdateWorkspaceBindingsParameters:
 
 @dataclass
 class ValidateCredentialRequest:
+    """Next ID: 17"""
+
     aws_iam_role: Optional[AwsIamRole] = None
     """The AWS IAM role configuration"""
 
@@ -9831,6 +9842,11 @@ class VolumeInfo:
     """The unique identifier of the volume"""
 
     volume_type: Optional[VolumeType] = None
+    """The type of the volume. An external volume is located in the specified external location. A
+    managed volume is located in the default location which is specified by the parent schema, or
+    the parent catalog, or the Metastore. [Learn more]
+    
+    [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external"""
 
     def as_dict(self) -> dict:
         """Serializes the VolumeInfo into a dictionary suitable for use as a JSON request body."""
@@ -9935,6 +9951,11 @@ class VolumeInfo:
 
 
 class VolumeType(Enum):
+    """The type of the volume. An external volume is located in the specified external location. A
+    managed volume is located in the default location which is specified by the parent schema, or
+    the parent catalog, or the Metastore. [Learn more]
+
+    [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external"""
 
     EXTERNAL = "EXTERNAL"
     MANAGED = "MANAGED"
@@ -14266,6 +14287,11 @@ class VolumesAPI:
         :param name: str
           The name of the volume
         :param volume_type: :class:`VolumeType`
+          The type of the volume. An external volume is located in the specified external location. A managed
+          volume is located in the default location which is specified by the parent schema, or the parent
+          catalog, or the Metastore. [Learn more]
+
+          [Learn more]: https://docs.databricks.com/aws/en/volumes/managed-vs-external
         :param comment: str (optional)
           The comment attached to the volume
         :param storage_location: str (optional)