databricks-sdk 0.17.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

databricks/sdk/service/ml.py

@@ -882,8 +882,7 @@ class ExperimentAccessControlRequest:
     """Permission level"""
 
     service_principal_name: Optional[str] = None
-    """Application ID of an active service principal. Setting this field requires the
-    `servicePrincipal/user` role."""
+    """application ID of a service principal"""
 
     user_name: Optional[str] = None
     """name of the user"""
@@ -2085,8 +2084,7 @@ class RegisteredModelAccessControlRequest:
     """Permission level"""
 
     service_principal_name: Optional[str] = None
-    """Application ID of an active service principal. Setting this field requires the
-    `servicePrincipal/user` role."""
+    """application ID of a service principal"""
 
     user_name: Optional[str] = None
     """name of the user"""
@@ -3594,7 +3592,8 @@ class ExperimentsAPI:
         """Delete runs by creation time.
         
         Bulk delete runs in an experiment that were created prior to or at the specified timestamp. Deletes at
-        most max_runs per request.
+        most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the
+        client code snippet on https://learn.microsoft.com/en-us/azure/databricks/mlflow/runs#bulk-delete.
         
         :param experiment_id: str
           The ID of the experiment containing the runs to delete.
@@ -3711,10 +3710,9 @@ class ExperimentsAPI:
 
         while True:
             json = self._api.do('GET', '/api/2.0/mlflow/metrics/get-history', query=query, headers=headers)
-            if 'metrics' not in json or not json['metrics']:
-                return
-            for v in json['metrics']:
-                yield Metric.from_dict(v)
+            if 'metrics' in json:
+                for v in json['metrics']:
+                    yield Metric.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -3808,10 +3806,9 @@ class ExperimentsAPI:
 
         while True:
             json = self._api.do('GET', '/api/2.0/mlflow/artifacts/list', query=query, headers=headers)
-            if 'files' not in json or not json['files']:
-                return
-            for v in json['files']:
-                yield FileInfo.from_dict(v)
+            if 'files' in json:
+                for v in json['files']:
+                    yield FileInfo.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -3845,10 +3842,9 @@ class ExperimentsAPI:
 
         while True:
             json = self._api.do('GET', '/api/2.0/mlflow/experiments/list', query=query, headers=headers)
-            if 'experiments' not in json or not json['experiments']:
-                return
-            for v in json['experiments']:
-                yield Experiment.from_dict(v)
+            if 'experiments' in json:
+                for v in json['experiments']:
+                    yield Experiment.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -4068,7 +4064,8 @@ class ExperimentsAPI:
         """Restore runs by deletion time.
         
         Bulk restore runs in an experiment that were deleted no earlier than the specified timestamp. Restores
-        at most max_runs per request.
+        at most max_runs per request. To call this API from a Databricks Notebook in Python, you can use the
+        client code snippet on https://learn.microsoft.com/en-us/azure/databricks/mlflow/runs#bulk-restore.
         
         :param experiment_id: str
           The ID of the experiment containing the runs to restore.
@@ -4125,10 +4122,9 @@ class ExperimentsAPI:
 
         while True:
             json = self._api.do('POST', '/api/2.0/mlflow/experiments/search', body=body, headers=headers)
-            if 'experiments' not in json or not json['experiments']:
-                return
-            for v in json['experiments']:
-                yield Experiment.from_dict(v)
+            if 'experiments' in json:
+                for v in json['experiments']:
+                    yield Experiment.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             body['page_token'] = json['next_page_token']
@@ -4186,10 +4182,9 @@ class ExperimentsAPI:
 
         while True:
             json = self._api.do('POST', '/api/2.0/mlflow/runs/search', body=body, headers=headers)
-            if 'runs' not in json or not json['runs']:
-                return
-            for v in json['runs']:
-                yield Run.from_dict(v)
+            if 'runs' in json:
+                for v in json['runs']:
+                    yield Run.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             body['page_token'] = json['next_page_token']
@@ -4903,10 +4898,9 @@ class ModelRegistryAPI:
 
         while True:
             json = self._api.do('GET', '/api/2.0/mlflow/registered-models/list', query=query, headers=headers)
-            if 'registered_models' not in json or not json['registered_models']:
-                return
-            for v in json['registered_models']:
-                yield Model.from_dict(v)
+            if 'registered_models' in json:
+                for v in json['registered_models']:
+                    yield Model.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -4963,10 +4957,9 @@ class ModelRegistryAPI:
 
         while True:
             json = self._api.do('GET', '/api/2.0/mlflow/registry-webhooks/list', query=query, headers=headers)
-            if 'webhooks' not in json or not json['webhooks']:
-                return
-            for v in json['webhooks']:
-                yield RegistryWebhook.from_dict(v)
+            if 'webhooks' in json:
+                for v in json['webhooks']:
+                    yield RegistryWebhook.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -5062,10 +5055,9 @@ class ModelRegistryAPI:
 
         while True:
             json = self._api.do('GET', '/api/2.0/mlflow/model-versions/search', query=query, headers=headers)
-            if 'model_versions' not in json or not json['model_versions']:
-                return
-            for v in json['model_versions']:
-                yield ModelVersion.from_dict(v)
+            if 'model_versions' in json:
+                for v in json['model_versions']:
+                    yield ModelVersion.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -5108,10 +5100,9 @@ class ModelRegistryAPI:
                                 '/api/2.0/mlflow/registered-models/search',
                                 query=query,
                                 headers=headers)
-            if 'registered_models' not in json or not json['registered_models']:
-                return
-            for v in json['registered_models']:
-                yield Model.from_dict(v)
+            if 'registered_models' in json:
+                for v in json['registered_models']:
+                    yield Model.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']

databricks/sdk/service/oauth2.py

@@ -629,10 +629,9 @@ class OAuthPublishedAppsAPI:
                                 f'/api/2.0/accounts/{self._api.account_id}/oauth2/published-apps/',
                                 query=query,
                                 headers=headers)
-            if 'apps' not in json or not json['apps']:
-                return
-            for v in json['apps']:
-                yield PublishedAppOutput.from_dict(v)
+            if 'apps' in json:
+                for v in json['apps']:
+                    yield PublishedAppOutput.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']

databricks/sdk/service/pipelines.py

@@ -724,8 +724,7 @@ class PipelineAccessControlRequest:
     """Permission level"""
 
     service_principal_name: Optional[str] = None
-    """Application ID of an active service principal. Setting this field requires the
-    `servicePrincipal/user` role."""
+    """application ID of a service principal"""
 
     user_name: Optional[str] = None
     """name of the user"""
@@ -792,7 +791,7 @@ class PipelineCluster:
     apply_policy_default_values: Optional[bool] = None
     """Note: This field won't be persisted. Only API users will check this field."""
 
-    autoscale: Optional[compute.AutoScale] = None
+    autoscale: Optional[PipelineClusterAutoscale] = None
     """Parameters needed in order to automatically scale clusters up and down based on load. Note:
     autoscaling works best with DB runtime versions 3.0 or later."""
 
@@ -915,7 +914,7 @@ class PipelineCluster:
     def from_dict(cls, d: Dict[str, any]) -> PipelineCluster:
         """Deserializes the PipelineCluster from a dictionary."""
         return cls(apply_policy_default_values=d.get('apply_policy_default_values', None),
-                   autoscale=_from_dict(d, 'autoscale', compute.AutoScale),
+                   autoscale=_from_dict(d, 'autoscale', PipelineClusterAutoscale),
                    aws_attributes=_from_dict(d, 'aws_attributes', compute.AwsAttributes),
                    azure_attributes=_from_dict(d, 'azure_attributes', compute.AzureAttributes),
                    cluster_log_conf=_from_dict(d, 'cluster_log_conf', compute.ClusterLogConf),
@@ -934,6 +933,48 @@ class PipelineCluster:
                    ssh_public_keys=d.get('ssh_public_keys', None))
 
 
+@dataclass
+class PipelineClusterAutoscale:
+    min_workers: int
+    """The minimum number of workers the cluster can scale down to when underutilized. It is also the
+    initial number of workers the cluster will have after creation."""
+
+    max_workers: int
+    """The maximum number of workers to which the cluster can scale up when overloaded. `max_workers`
+    must be strictly greater than `min_workers`."""
+
+    mode: Optional[PipelineClusterAutoscaleMode] = None
+    """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. Enhanced Autoscaling is available for `updates` clusters only. The legacy
+    autoscaling feature is used for `maintenance` clusters."""
+
+    def as_dict(self) -> dict:
+        """Serializes the PipelineClusterAutoscale into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.max_workers is not None: body['max_workers'] = self.max_workers
+        if self.min_workers is not None: body['min_workers'] = self.min_workers
+        if self.mode is not None: body['mode'] = self.mode.value
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> PipelineClusterAutoscale:
+        """Deserializes the PipelineClusterAutoscale from a dictionary."""
+        return cls(max_workers=d.get('max_workers', None),
+                   min_workers=d.get('min_workers', None),
+                   mode=_enum(d, 'mode', PipelineClusterAutoscaleMode))
+
+
+class PipelineClusterAutoscaleMode(Enum):
+    """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. Enhanced Autoscaling is available for `updates` clusters only. The legacy
+    autoscaling feature is used for `maintenance` clusters."""
+
+    ENHANCED = 'ENHANCED'
+    LEGACY = 'LEGACY'
+
+
 @dataclass
 class PipelineEvent:
     error: Optional[ErrorDetail] = None
@@ -1892,10 +1933,9 @@ class PipelinesAPI:
                                 f'/api/2.0/pipelines/{pipeline_id}/events',
                                 query=query,
                                 headers=headers)
-            if 'events' not in json or not json['events']:
-                return
-            for v in json['events']:
-                yield PipelineEvent.from_dict(v)
+            if 'events' in json:
+                for v in json['events']:
+                    yield PipelineEvent.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -1941,10 +1981,9 @@ class PipelinesAPI:
 
         while True:
             json = self._api.do('GET', '/api/2.0/pipelines', query=query, headers=headers)
-            if 'statuses' not in json or not json['statuses']:
-                return
-            for v in json['statuses']:
-                yield PipelineStateInfo.from_dict(v)
+            if 'statuses' in json:
+                for v in json['statuses']:
+                    yield PipelineStateInfo.from_dict(v)
             if 'next_page_token' not in json or not json['next_page_token']:
                 return
             query['page_token'] = json['next_page_token']
@@ -1979,25 +2018,6 @@ class PipelinesAPI:
         res = self._api.do('GET', f'/api/2.0/pipelines/{pipeline_id}/updates', query=query, headers=headers)
         return ListUpdatesResponse.from_dict(res)
 
-    def reset(self, pipeline_id: str) -> Wait[GetPipelineResponse]:
-        """Reset a pipeline.
-        
-        Resets a pipeline.
-        
-        :param pipeline_id: str
-        
-        :returns:
-          Long-running operation waiter for :class:`GetPipelineResponse`.
-          See :method:wait_get_pipeline_running for more details.
-        """
-
-        headers = {'Accept': 'application/json', }
-        self._api.do('POST', f'/api/2.0/pipelines/{pipeline_id}/reset', headers=headers)
-        return Wait(self.wait_get_pipeline_running, pipeline_id=pipeline_id)
-
-    def reset_and_wait(self, pipeline_id: str, timeout=timedelta(minutes=20)) -> GetPipelineResponse:
-        return self.reset(pipeline_id=pipeline_id).result(timeout=timeout)
-
     def set_permissions(
             self,
             pipeline_id: str,

databricks/sdk/service/serving.py

@@ -1939,8 +1939,7 @@ class ServingEndpointAccessControlRequest:
     """Permission level"""
 
     service_principal_name: Optional[str] = None
-    """Application ID of an active service principal. Setting this field requires the
-    `servicePrincipal/user` role."""
+    """application ID of a service principal"""
 
     user_name: Optional[str] = None
     """name of the user"""