databricks-sdk 0.69.0__py3-none-any.whl → 0.71.0__py3-none-any.whl

databricks/sdk/service/sql.py

@@ -331,6 +331,12 @@ class AlertEvaluationState(Enum):
     UNKNOWN = "UNKNOWN"
 
 
+class AlertLifecycleState(Enum):
+
+    ACTIVE = "ACTIVE"
+    DELETED = "DELETED"
+
+
 @dataclass
 class AlertOperandColumn:
     name: Optional[str] = None
@@ -636,6 +642,19 @@ class AlertState(Enum):
 
 @dataclass
 class AlertV2:
+    display_name: str
+    """The display name of the alert."""
+
+    query_text: str
+    """Text of the query to be run."""
+
+    warehouse_id: str
+    """ID of the SQL warehouse attached to the alert."""
+
+    evaluation: AlertV2Evaluation
+
+    schedule: CronSchedule
+
     create_time: Optional[str] = None
     """The timestamp indicating when the alert was created."""
 
@@ -645,19 +664,14 @@ class AlertV2:
     custom_summary: Optional[str] = None
     """Custom summary for the alert. support mustache template."""
 
-    display_name: Optional[str] = None
-    """The display name of the alert."""
-
     effective_run_as: Optional[AlertV2RunAs] = None
     """The actual identity that will be used to execute the alert. This is an output-only field that
     shows the resolved run-as identity after applying permissions and defaults."""
 
-    evaluation: Optional[AlertV2Evaluation] = None
-
     id: Optional[str] = None
     """UUID identifying the alert."""
 
-    lifecycle_state: Optional[LifecycleState] = None
+    lifecycle_state: Optional[AlertLifecycleState] = None
     """Indicates whether the query is trashed."""
 
     owner_user_name: Optional[str] = None
@@ -667,9 +681,6 @@ class AlertV2:
     """The workspace path of the folder containing the alert. Can only be set on create, and cannot be
     updated."""
 
-    query_text: Optional[str] = None
-    """Text of the query to be run."""
-
     run_as: Optional[AlertV2RunAs] = None
     """Specifies the identity that will be used to run the alert. This field allows you to configure
     alerts to run as a specific user or service principal. - For user identity: Set `user_name` to
@@ -683,14 +694,9 @@ class AlertV2:
     servicePrincipal/user role. Deprecated: Use `run_as` field instead. This field will be removed
     in a future release."""
 
-    schedule: Optional[CronSchedule] = None
-
     update_time: Optional[str] = None
     """The timestamp indicating when the alert was updated."""
 
-    warehouse_id: Optional[str] = None
-    """ID of the SQL warehouse attached to the alert."""
-
     def as_dict(self) -> dict:
         """Serializes the AlertV2 into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -776,7 +782,7 @@ class AlertV2:
             effective_run_as=_from_dict(d, "effective_run_as", AlertV2RunAs),
             evaluation=_from_dict(d, "evaluation", AlertV2Evaluation),
             id=d.get("id", None),
-            lifecycle_state=_enum(d, "lifecycle_state", LifecycleState),
+            lifecycle_state=_enum(d, "lifecycle_state", AlertLifecycleState),
             owner_user_name=d.get("owner_user_name", None),
             parent_path=d.get("parent_path", None),
             query_text=d.get("query_text", None),
@@ -790,7 +796,10 @@ class AlertV2:
 
 @dataclass
 class AlertV2Evaluation:
-    comparison_operator: Optional[ComparisonOperator] = None
+    source: AlertV2OperandColumn
+    """Source column from result to use to evaluate alert"""
+
+    comparison_operator: ComparisonOperator
     """Operator used for comparison in alert evaluation."""
 
     empty_result_state: Optional[AlertEvaluationState] = None
@@ -803,9 +812,6 @@ class AlertV2Evaluation:
     notification: Optional[AlertV2Notification] = None
     """User or Notification Destination to notify when alert is triggered."""
 
-    source: Optional[AlertV2OperandColumn] = None
-    """Source column from result to use to evaluate alert"""
-
     state: Optional[AlertEvaluationState] = None
     """Latest state of alert evaluation."""
 
@@ -941,12 +947,12 @@ class AlertV2Operand:
 
 @dataclass
 class AlertV2OperandColumn:
+    name: str
+
     aggregation: Optional[Aggregation] = None
 
     display: Optional[str] = None
 
-    name: Optional[str] = None
-
     def as_dict(self) -> dict:
         """Serializes the AlertV2OperandColumn into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -1132,24 +1138,6 @@ class BaseChunkInfo:
         )
 
 
-@dataclass
-class CancelExecutionResponse:
-    def as_dict(self) -> dict:
-        """Serializes the CancelExecutionResponse into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CancelExecutionResponse into a shallow dictionary of its immediate attributes."""
-        body = {}
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CancelExecutionResponse:
-        """Deserializes the CancelExecutionResponse from a dictionary."""
-        return cls()
-
-
 @dataclass
 class Channel:
     """Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be
@@ -1718,20 +1706,20 @@ class CreateWarehouseResponse:
 
 @dataclass
 class CronSchedule:
-    pause_status: Optional[SchedulePauseStatus] = None
-    """Indicate whether this schedule is paused or not."""
-
-    quartz_cron_schedule: Optional[str] = None
+    quartz_cron_schedule: str
     """A cron expression using quartz syntax that specifies the schedule for this pipeline. Should use
     the quartz format described here:
     http://www.quartz-scheduler.org/documentation/quartz-2.1.7/tutorials/tutorial-lesson-06.html"""
 
-    timezone_id: Optional[str] = None
+    timezone_id: str
     """A Java timezone id. The schedule will be resolved using this timezone. This will be combined
     with the quartz_cron_schedule to determine the schedule. See
     https://docs.databricks.com/sql/language-manual/sql-ref-syntax-aux-conf-mgmt-set-timezone.html
     for details."""
 
+    pause_status: Optional[SchedulePauseStatus] = None
+    """Indicate whether this schedule is paused or not."""
+
     def as_dict(self) -> dict:
         """Serializes the CronSchedule into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -3929,9 +3917,6 @@ class ListAlertsV2Response:
 
     next_page_token: Optional[str] = None
 
-    results: Optional[List[AlertV2]] = None
-    """Deprecated. Use `alerts` instead."""
-
     def as_dict(self) -> dict:
         """Serializes the ListAlertsV2Response into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -3939,8 +3924,6 @@ class ListAlertsV2Response:
             body["alerts"] = [v.as_dict() for v in self.alerts]
         if self.next_page_token is not None:
             body["next_page_token"] = self.next_page_token
-        if self.results:
-            body["results"] = [v.as_dict() for v in self.results]
         return body
 
     def as_shallow_dict(self) -> dict:
@@ -3950,18 +3933,12 @@ class ListAlertsV2Response:
             body["alerts"] = self.alerts
         if self.next_page_token is not None:
             body["next_page_token"] = self.next_page_token
-        if self.results:
-            body["results"] = self.results
         return body
 
     @classmethod
     def from_dict(cls, d: Dict[str, Any]) -> ListAlertsV2Response:
         """Deserializes the ListAlertsV2Response from a dictionary."""
-        return cls(
-            alerts=_repeated_dict(d, "alerts", AlertV2),
-            next_page_token=d.get("next_page_token", None),
-            results=_repeated_dict(d, "results", AlertV2),
-        )
+        return cls(alerts=_repeated_dict(d, "alerts", AlertV2), next_page_token=d.get("next_page_token", None))
 
 
 class ListOrder(Enum):
@@ -5122,7 +5099,7 @@ class QueryMetrics:
     queue."""
 
     pruned_bytes: Optional[int] = None
-    """Total number of bytes in all tables not read due to pruning"""
+    """Total number of file bytes in all tables not read due to pruning"""
 
     pruned_files_count: Optional[int] = None
     """Total number of files from all tables not read due to pruning"""
@@ -5136,6 +5113,9 @@ class QueryMetrics:
     read_cache_bytes: Optional[int] = None
     """Size of persistent data read from the cache, in bytes."""
 
+    read_files_bytes: Optional[int] = None
+    """Total number of file bytes in all tables read"""
+
     read_files_count: Optional[int] = None
     """Number of files read after pruning"""
 
@@ -5215,6 +5195,8 @@ class QueryMetrics:
             body["read_bytes"] = self.read_bytes
         if self.read_cache_bytes is not None:
             body["read_cache_bytes"] = self.read_cache_bytes
+        if self.read_files_bytes is not None:
+            body["read_files_bytes"] = self.read_files_bytes
         if self.read_files_count is not None:
             body["read_files_count"] = self.read_files_count
         if self.read_partitions_count is not None:
@@ -5276,6 +5258,8 @@ class QueryMetrics:
             body["read_bytes"] = self.read_bytes
         if self.read_cache_bytes is not None:
             body["read_cache_bytes"] = self.read_cache_bytes
+        if self.read_files_bytes is not None:
+            body["read_files_bytes"] = self.read_files_bytes
         if self.read_files_count is not None:
             body["read_files_count"] = self.read_files_count
         if self.read_partitions_count is not None:
@@ -5325,6 +5309,7 @@ class QueryMetrics:
             query_compilation_start_timestamp=d.get("query_compilation_start_timestamp", None),
             read_bytes=d.get("read_bytes", None),
             read_cache_bytes=d.get("read_cache_bytes", None),
+            read_files_bytes=d.get("read_files_bytes", None),
             read_files_count=d.get("read_files_count", None),
             read_partitions_count=d.get("read_partitions_count", None),
             read_remote_bytes=d.get("read_remote_bytes", None),
@@ -6310,6 +6295,7 @@ class TerminationReasonCode(Enum):
     DATABASE_CONNECTION_FAILURE = "DATABASE_CONNECTION_FAILURE"
     DATA_ACCESS_CONFIG_CHANGED = "DATA_ACCESS_CONFIG_CHANGED"
     DBFS_COMPONENT_UNHEALTHY = "DBFS_COMPONENT_UNHEALTHY"
+    DBR_IMAGE_RESOLUTION_FAILURE = "DBR_IMAGE_RESOLUTION_FAILURE"
     DISASTER_RECOVERY_REPLICATION = "DISASTER_RECOVERY_REPLICATION"
     DNS_RESOLUTION_ERROR = "DNS_RESOLUTION_ERROR"
     DOCKER_CONTAINER_CREATION_EXCEPTION = "DOCKER_CONTAINER_CREATION_EXCEPTION"
@@ -6378,11 +6364,21 @@ class TerminationReasonCode(Enum):
     NEPHOS_RESOURCE_MANAGEMENT = "NEPHOS_RESOURCE_MANAGEMENT"
     NETVISOR_SETUP_TIMEOUT = "NETVISOR_SETUP_TIMEOUT"
     NETWORK_CHECK_CONTROL_PLANE_FAILURE = "NETWORK_CHECK_CONTROL_PLANE_FAILURE"
+    NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG = "NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG"
     NETWORK_CHECK_DNS_SERVER_FAILURE = "NETWORK_CHECK_DNS_SERVER_FAILURE"
+    NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG = "NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG"
     NETWORK_CHECK_METADATA_ENDPOINT_FAILURE = "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE"
+    NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG = (
+        "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG"
+    )
     NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE = "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE"
+    NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG = (
+        "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG"
+    )
     NETWORK_CHECK_NIC_FAILURE = "NETWORK_CHECK_NIC_FAILURE"
+    NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG = "NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG"
     NETWORK_CHECK_STORAGE_FAILURE = "NETWORK_CHECK_STORAGE_FAILURE"
+    NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG = "NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG"
     NETWORK_CONFIGURATION_FAILURE = "NETWORK_CONFIGURATION_FAILURE"
     NFS_MOUNT_FAILURE = "NFS_MOUNT_FAILURE"
     NO_ACTIVATED_K8S = "NO_ACTIVATED_K8S"
@@ -7400,6 +7396,7 @@ class AlertsAPI:
 
         :returns: :class:`Alert`
         """
+
         body = {}
         if alert is not None:
             body["alert"] = alert.as_dict()
@@ -7502,6 +7499,7 @@ class AlertsAPI:
 
         :returns: :class:`Alert`
         """
+
         body = {}
         if alert is not None:
             body["alert"] = alert.as_dict()
@@ -7563,6 +7561,7 @@ class AlertsLegacyAPI:
 
         :returns: :class:`LegacyAlert`
         """
+
         body = {}
         if name is not None:
             body["name"] = name
@@ -7662,6 +7661,7 @@ class AlertsLegacyAPI:
 
 
         """
+
         body = {}
         if name is not None:
             body["name"] = name
@@ -7692,6 +7692,7 @@ class AlertsV2API:
 
         :returns: :class:`AlertV2`
         """
+
         body = alert.as_dict()
         headers = {
             "Accept": "application/json",
@@ -7736,8 +7737,8 @@ class AlertsV2API:
 
         while True:
             json = self._api.do("GET", "/api/2.0/alerts", query=query, headers=headers)
-            if "results" in json:
-                for v in json["results"]:
+            if "alerts" in json:
+                for v in json["alerts"]:
                     yield AlertV2.from_dict(v)
             if "next_page_token" not in json or not json["next_page_token"]:
                 return
@@ -7778,6 +7779,7 @@ class AlertsV2API:
 
         :returns: :class:`AlertV2`
         """
+
         body = alert.as_dict()
         query = {}
         if update_mask is not None:
@@ -7822,6 +7824,7 @@ class DashboardWidgetsAPI:
 
         :returns: :class:`Widget`
         """
+
         body = {}
         if dashboard_id is not None:
             body["dashboard_id"] = dashboard_id
@@ -7883,6 +7886,7 @@ class DashboardWidgetsAPI:
 
         :returns: :class:`Widget`
         """
+
         body = {}
         if dashboard_id is not None:
             body["dashboard_id"] = dashboard_id
@@ -8028,6 +8032,7 @@ class DashboardsAPI:
 
         :returns: :class:`Dashboard`
         """
+
         body = {}
         if name is not None:
             body["name"] = name
@@ -8148,6 +8153,7 @@ class DbsqlPermissionsAPI:
 
         :returns: :class:`SetResponse`
         """
+
         body = {}
         if access_control_list is not None:
             body["access_control_list"] = [v.as_dict() for v in access_control_list]
@@ -8180,6 +8186,7 @@ class DbsqlPermissionsAPI:
 
         :returns: :class:`Success`
         """
+
         body = {}
         if new_owner is not None:
             body["new_owner"] = new_owner
@@ -8217,6 +8224,7 @@ class QueriesAPI:
 
         :returns: :class:`Query`
         """
+
         body = {}
         if auto_resolve_display_name is not None:
             body["auto_resolve_display_name"] = auto_resolve_display_name
@@ -8349,6 +8357,7 @@ class QueriesAPI:
 
         :returns: :class:`Query`
         """
+
         body = {}
         if auto_resolve_display_name is not None:
             body["auto_resolve_display_name"] = auto_resolve_display_name
@@ -8428,6 +8437,7 @@ class QueriesLegacyAPI:
 
         :returns: :class:`LegacyQuery`
         """
+
         body = {}
         if data_source_id is not None:
             body["data_source_id"] = data_source_id
@@ -8623,6 +8633,7 @@ class QueriesLegacyAPI:
 
         :returns: :class:`LegacyQuery`
         """
+
         body = {}
         if data_source_id is not None:
             body["data_source_id"] = data_source_id
@@ -8716,6 +8727,7 @@ class QueryVisualizationsAPI:
 
         :returns: :class:`Visualization`
         """
+
         body = {}
         if visualization is not None:
             body["visualization"] = visualization.as_dict()
@@ -8761,6 +8773,7 @@ class QueryVisualizationsAPI:
 
         :returns: :class:`Visualization`
         """
+
         body = {}
         if update_mask is not None:
             body["update_mask"] = update_mask
@@ -8811,6 +8824,7 @@ class QueryVisualizationsLegacyAPI:
 
         :returns: :class:`LegacyVisualization`
         """
+
         body = {}
         if description is not None:
             body["description"] = description
@@ -8852,10 +8866,10 @@ class QueryVisualizationsLegacyAPI:
 
     def update(
         self,
-        id: str,
         *,
         created_at: Optional[str] = None,
         description: Optional[str] = None,
+        id: Optional[str] = None,
         name: Optional[str] = None,
         options: Optional[Any] = None,
         query: Optional[LegacyQuery] = None,
@@ -8869,11 +8883,11 @@ class QueryVisualizationsLegacyAPI:
 
         [Learn more]: https://docs.databricks.com/en/sql/dbsql-api-latest.html
 
-        :param id: str
-          The UUID for this visualization.
         :param created_at: str (optional)
         :param description: str (optional)
           A short description of this visualization. This is not displayed in the UI.
+        :param id: str (optional)
+          The UUID for this visualization.
         :param name: str (optional)
           The name of the visualization that appears on dashboards and the query screen.
         :param options: Any (optional)
@@ -8886,11 +8900,14 @@ class QueryVisualizationsLegacyAPI:
 
         :returns: :class:`LegacyVisualization`
         """
+
         body = {}
         if created_at is not None:
             body["created_at"] = created_at
         if description is not None:
             body["description"] = description
+        if id is not None:
+            body["id"] = id
         if name is not None:
             body["name"] = name
         if options is not None:
@@ -9224,6 +9241,7 @@ class StatementExecutionAPI:
 
         :returns: :class:`StatementResponse`
         """
+
         body = {}
         if byte_limit is not None:
             body["byte_limit"] = byte_limit
@@ -9452,6 +9470,7 @@ class WarehousesAPI:
           Long-running operation waiter for :class:`GetWarehouseResponse`.
           See :method:wait_get_warehouse_running for more details.
         """
+
         body = {}
         if auto_stop_mins is not None:
             body["auto_stop_mins"] = auto_stop_mins
@@ -9621,6 +9640,7 @@ class WarehousesAPI:
           Long-running operation waiter for :class:`GetWarehouseResponse`.
           See :method:wait_get_warehouse_running for more details.
         """
+
         body = {}
         if auto_stop_mins is not None:
             body["auto_stop_mins"] = auto_stop_mins
@@ -9807,6 +9827,7 @@ class WarehousesAPI:
 
         :returns: :class:`WarehousePermissions`
         """
+
         body = {}
         if access_control_list is not None:
             body["access_control_list"] = [v.as_dict() for v in access_control_list]
@@ -9862,6 +9883,7 @@ class WarehousesAPI:
 
 
         """
+
         body = {}
         if channel is not None:
             body["channel"] = channel.as_dict()
@@ -9944,6 +9966,7 @@ class WarehousesAPI:
 
         :returns: :class:`WarehousePermissions`
         """
+
         body = {}
         if access_control_list is not None:
             body["access_control_list"] = [v.as_dict() for v in access_control_list]

databricks/sdk/service/tags.py

@@ -149,6 +149,7 @@ class TagPoliciesAPI:
 
         :returns: :class:`TagPolicy`
         """
+
         body = tag_policy.as_dict()
         headers = {
             "Accept": "application/json",
@@ -238,6 +239,7 @@ class TagPoliciesAPI:
 
         :returns: :class:`TagPolicy`
         """
+
         body = tag_policy.as_dict()
         query = {}
         if update_mask is not None:

databricks/sdk/service/vectorsearch.py

@@ -1429,6 +1429,7 @@ class VectorSearchEndpointsAPI:
           Long-running operation waiter for :class:`EndpointInfo`.
           See :method:wait_get_endpoint_vector_search_endpoint_online for more details.
         """
+
         body = {}
         if budget_policy_id is not None:
             body["budget_policy_id"] = budget_policy_id
@@ -1529,6 +1530,7 @@ class VectorSearchEndpointsAPI:
 
         :returns: :class:`PatchEndpointBudgetPolicyResponse`
         """
+
         body = {}
         if budget_policy_id is not None:
             body["budget_policy_id"] = budget_policy_id
@@ -1554,6 +1556,7 @@ class VectorSearchEndpointsAPI:
 
         :returns: :class:`UpdateEndpointCustomTagsResponse`
         """
+
         body = {}
         if custom_tags is not None:
             body["custom_tags"] = [v.as_dict() for v in custom_tags]
@@ -1606,6 +1609,7 @@ class VectorSearchIndexesAPI:
 
         :returns: :class:`VectorIndex`
         """
+
         body = {}
         if delta_sync_index_spec is not None:
             body["delta_sync_index_spec"] = delta_sync_index_spec.as_dict()
@@ -1762,6 +1766,7 @@ class VectorSearchIndexesAPI:
 
         :returns: :class:`QueryVectorIndexResponse`
         """
+
         body = {}
         if columns is not None:
             body["columns"] = [v for v in columns]
@@ -1804,6 +1809,7 @@ class VectorSearchIndexesAPI:
 
         :returns: :class:`QueryVectorIndexResponse`
         """
+
         body = {}
         if endpoint_name is not None:
             body["endpoint_name"] = endpoint_name
@@ -1834,6 +1840,7 @@ class VectorSearchIndexesAPI:
 
         :returns: :class:`ScanVectorIndexResponse`
         """
+
         body = {}
         if last_primary_key is not None:
             body["last_primary_key"] = last_primary_key
@@ -1872,6 +1879,7 @@ class VectorSearchIndexesAPI:
 
         :returns: :class:`UpsertDataVectorIndexResponse`
         """
+
         body = {}
         if inputs_json is not None:
             body["inputs_json"] = inputs_json