databricks-sdk 0.62.0__py3-none-any.whl → 0.64.0__py3-none-any.whl

databricks/sdk/service/jobs.py

@@ -42,6 +42,9 @@ class BaseJob:
     Jobs UI in the job details page and Jobs API using `budget_policy_id` 3. Inferred default based
     on accessible budget policies of the run_as identity on job creation or modification."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this job for cost attribution purposes."""
+
     has_more: Optional[bool] = None
     """Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown.
     They can be accessed via :method:jobs/get endpoint. It is only relevant for API 2.2
@@ -66,6 +69,8 @@ class BaseJob:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -85,6 +90,8 @@ class BaseJob:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -102,6 +109,7 @@ class BaseJob:
             created_time=d.get("created_time", None),
             creator_user_name=d.get("creator_user_name", None),
             effective_budget_policy_id=d.get("effective_budget_policy_id", None),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             has_more=d.get("has_more", None),
             job_id=d.get("job_id", None),
             settings=_from_dict(d, "settings", JobSettings),
@@ -147,6 +155,9 @@ class BaseRun:
     `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
     optimized cluster performance."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this run for cost attribution purposes."""
+
     end_time: Optional[int] = None
     """The time at which this run ended in epoch milliseconds (milliseconds since 1/1/1970 UTC). This
     field is set to 0 if the job is still running."""
@@ -267,6 +278,8 @@ class BaseRun:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target.value
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -338,6 +351,8 @@ class BaseRun:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -403,6 +418,7 @@ class BaseRun:
             creator_user_name=d.get("creator_user_name", None),
             description=d.get("description", None),
             effective_performance_target=_enum(d, "effective_performance_target", PerformanceTarget),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             end_time=d.get("end_time", None),
             execution_duration=d.get("execution_duration", None),
             git_source=_from_dict(d, "git_source", GitSource),
@@ -2212,6 +2228,9 @@ class Job:
     Jobs UI in the job details page and Jobs API using `budget_policy_id` 3. Inferred default based
     on accessible budget policies of the run_as identity on job creation or modification."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this job for cost attribution purposes."""
+
     has_more: Optional[bool] = None
     """Indicates if the job has more array properties (`tasks`, `job_clusters`) that are not shown.
     They can be accessed via :method:jobs/get endpoint. It is only relevant for API 2.2
@@ -2248,6 +2267,8 @@ class Job:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -2271,6 +2292,8 @@ class Job:
             body["creator_user_name"] = self.creator_user_name
         if self.effective_budget_policy_id is not None:
             body["effective_budget_policy_id"] = self.effective_budget_policy_id
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.has_more is not None:
             body["has_more"] = self.has_more
         if self.job_id is not None:
@@ -2292,6 +2315,7 @@ class Job:
             created_time=d.get("created_time", None),
             creator_user_name=d.get("creator_user_name", None),
             effective_budget_policy_id=d.get("effective_budget_policy_id", None),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             has_more=d.get("has_more", None),
             job_id=d.get("job_id", None),
             next_page_token=d.get("next_page_token", None),
@@ -3037,6 +3061,11 @@ class JobSettings:
     the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API
     request to `runNow`."""
 
+    usage_policy_id: Optional[str] = None
+    """The id of the user specified usage policy to use for this job. If not specified, a default usage
+    policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for
+    the usage policy used by this workload."""
+
     webhook_notifications: Optional[WebhookNotifications] = None
     """A collection of system notification IDs to notify when runs of this job begin or complete."""
 
@@ -3089,6 +3118,8 @@ class JobSettings:
             body["timeout_seconds"] = self.timeout_seconds
         if self.trigger:
             body["trigger"] = self.trigger.as_dict()
+        if self.usage_policy_id is not None:
+            body["usage_policy_id"] = self.usage_policy_id
         if self.webhook_notifications:
             body["webhook_notifications"] = self.webhook_notifications.as_dict()
         return body
@@ -3142,6 +3173,8 @@ class JobSettings:
             body["timeout_seconds"] = self.timeout_seconds
         if self.trigger:
             body["trigger"] = self.trigger
+        if self.usage_policy_id is not None:
+            body["usage_policy_id"] = self.usage_policy_id
         if self.webhook_notifications:
             body["webhook_notifications"] = self.webhook_notifications
         return body
@@ -3173,6 +3206,7 @@ class JobSettings:
             tasks=_repeated_dict(d, "tasks", Task),
             timeout_seconds=d.get("timeout_seconds", None),
             trigger=_from_dict(d, "trigger", TriggerSettings),
+            usage_policy_id=d.get("usage_policy_id", None),
             webhook_notifications=_from_dict(d, "webhook_notifications", WebhookNotifications),
         )
 
@@ -4499,6 +4533,9 @@ class Run:
     `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
     optimized cluster performance."""
 
+    effective_usage_policy_id: Optional[str] = None
+    """The id of the usage policy used by this run for cost attribution purposes."""
+
     end_time: Optional[int] = None
     """The time at which this run ended in epoch milliseconds (milliseconds since 1/1/1970 UTC). This
     field is set to 0 if the job is still running."""
@@ -4625,6 +4662,8 @@ class Run:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target.value
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -4700,6 +4739,8 @@ class Run:
             body["description"] = self.description
         if self.effective_performance_target is not None:
             body["effective_performance_target"] = self.effective_performance_target
+        if self.effective_usage_policy_id is not None:
+            body["effective_usage_policy_id"] = self.effective_usage_policy_id
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.execution_duration is not None:
@@ -4769,6 +4810,7 @@ class Run:
             creator_user_name=d.get("creator_user_name", None),
             description=d.get("description", None),
             effective_performance_target=_enum(d, "effective_performance_target", PerformanceTarget),
+            effective_usage_policy_id=d.get("effective_usage_policy_id", None),
             end_time=d.get("end_time", None),
             execution_duration=d.get("execution_duration", None),
             git_source=_from_dict(d, "git_source", GitSource),
@@ -7884,6 +7926,8 @@ class TerminationCodeCode(Enum):
     run failed due to a cloud provider issue. Refer to the state message for further details. *
     `MAX_JOB_QUEUE_SIZE_EXCEEDED`: The run was skipped due to reaching the job level queue size
     limit. * `DISABLED`: The run was never executed because it was disabled explicitly by the user.
+    * `BREAKING_CHANGE`: Run failed because of an intentional breaking change in Spark, but it will
+    be retried with a mitigation config.
 
     [Link]: https://kb.databricks.com/en_US/notebooks/too-many-execution-contexts-are-open-right-now"""
 
@@ -8437,6 +8481,7 @@ class JobsAPI:
         tasks: Optional[List[Task]] = None,
         timeout_seconds: Optional[int] = None,
         trigger: Optional[TriggerSettings] = None,
+        usage_policy_id: Optional[str] = None,
         webhook_notifications: Optional[WebhookNotifications] = None,
     ) -> CreateResponse:
         """Create a new job.
@@ -8531,6 +8576,10 @@ class JobsAPI:
           A configuration to trigger a run when certain conditions are met. The default behavior is that the
           job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request to
           `runNow`.
+        :param usage_policy_id: str (optional)
+          The id of the user specified usage policy to use for this job. If not specified, a default usage
+          policy may be applied when creating or modifying the job. See `effective_usage_policy_id` for the
+          usage policy used by this workload.
         :param webhook_notifications: :class:`WebhookNotifications` (optional)
           A collection of system notification IDs to notify when runs of this job begin or complete.
 
@@ -8585,6 +8634,8 @@ class JobsAPI:
             body["timeout_seconds"] = timeout_seconds
         if trigger is not None:
             body["trigger"] = trigger.as_dict()
+        if usage_policy_id is not None:
+            body["usage_policy_id"] = usage_policy_id
         if webhook_notifications is not None:
             body["webhook_notifications"] = webhook_notifications.as_dict()
         headers = {
@@ -9381,6 +9432,7 @@ class JobsAPI:
         run_name: Optional[str] = None,
         tasks: Optional[List[SubmitTask]] = None,
         timeout_seconds: Optional[int] = None,
+        usage_policy_id: Optional[str] = None,
         webhook_notifications: Optional[WebhookNotifications] = None,
     ) -> Wait[Run]:
         """Submit a one-time run. This endpoint allows you to submit a workload directly without creating a job.
@@ -9432,6 +9484,9 @@ class JobsAPI:
         :param tasks: List[:class:`SubmitTask`] (optional)
         :param timeout_seconds: int (optional)
           An optional timeout applied to each run of this job. A value of `0` means no timeout.
+        :param usage_policy_id: str (optional)
+          The user specified id of the usage policy to use for this one-time run. If not specified, a default
+          usage policy may be applied when creating or modifying the job.
         :param webhook_notifications: :class:`WebhookNotifications` (optional)
           A collection of system notification IDs to notify when the run begins or completes.
 
@@ -9466,6 +9521,8 @@ class JobsAPI:
             body["tasks"] = [v.as_dict() for v in tasks]
         if timeout_seconds is not None:
             body["timeout_seconds"] = timeout_seconds
+        if usage_policy_id is not None:
+            body["usage_policy_id"] = usage_policy_id
         if webhook_notifications is not None:
             body["webhook_notifications"] = webhook_notifications.as_dict()
         headers = {
@@ -9496,6 +9553,7 @@ class JobsAPI:
         run_name: Optional[str] = None,
         tasks: Optional[List[SubmitTask]] = None,
         timeout_seconds: Optional[int] = None,
+        usage_policy_id: Optional[str] = None,
         webhook_notifications: Optional[WebhookNotifications] = None,
         timeout=timedelta(minutes=20),
     ) -> Run:
@@ -9513,6 +9571,7 @@ class JobsAPI:
             run_name=run_name,
             tasks=tasks,
             timeout_seconds=timeout_seconds,
+            usage_policy_id=usage_policy_id,
             webhook_notifications=webhook_notifications,
         ).result(timeout=timeout)
 

databricks/sdk/service/ml.py

@@ -3494,10 +3494,8 @@ class PublishSpec:
     online_table_name: str
     """The full three-part (catalog, schema, table) name of the online table."""
 
-    publish_mode: Optional[PublishSpecPublishMode] = None
-    """The publish mode of the pipeline that syncs the online table with the source table. Defaults to
-    TRIGGERED if not specified. All publish modes require the source table to have Change Data Feed
-    (CDF) enabled."""
+    publish_mode: PublishSpecPublishMode
+    """The publish mode of the pipeline that syncs the online table with the source table."""
 
     def as_dict(self) -> dict:
         """Serializes the PublishSpec into a dictionary suitable for use as a JSON request body."""
@@ -3534,6 +3532,7 @@ class PublishSpec:
 class PublishSpecPublishMode(Enum):
 
     CONTINUOUS = "CONTINUOUS"
+    SNAPSHOT = "SNAPSHOT"
     TRIGGERED = "TRIGGERED"
 
 

databricks/sdk/service/serving.py

@@ -314,6 +314,9 @@ class AiGatewayRateLimit:
     """Principal field for a user, user group, or service principal to apply rate limiting to. Accepts
     a user email, group name, or service principal application ID."""
 
+    tokens: Optional[int] = None
+    """Used to specify how many tokens are allowed for a key within the renewal_period."""
+
     def as_dict(self) -> dict:
         """Serializes the AiGatewayRateLimit into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -325,6 +328,8 @@ class AiGatewayRateLimit:
             body["principal"] = self.principal
         if self.renewal_period is not None:
             body["renewal_period"] = self.renewal_period.value
+        if self.tokens is not None:
+            body["tokens"] = self.tokens
         return body
 
     def as_shallow_dict(self) -> dict:
@@ -338,6 +343,8 @@ class AiGatewayRateLimit:
             body["principal"] = self.principal
         if self.renewal_period is not None:
             body["renewal_period"] = self.renewal_period
+        if self.tokens is not None:
+            body["tokens"] = self.tokens
         return body
 
     @classmethod
@@ -348,6 +355,7 @@ class AiGatewayRateLimit:
             key=_enum(d, "key", AiGatewayRateLimitKey),
             principal=d.get("principal", None),
             renewal_period=_enum(d, "renewal_period", AiGatewayRateLimitRenewalPeriod),
+            tokens=d.get("tokens", None),
         )
 
 
@@ -3374,6 +3382,9 @@ class ServingEndpoint:
     task: Optional[str] = None
     """The task type of the serving endpoint."""
 
+    usage_policy_id: Optional[str] = None
+    """The usage policy associated with serving endpoint."""
+
     def as_dict(self) -> dict:
         """Serializes the ServingEndpoint into a dictionary suitable for use as a JSON request body."""
         body = {}
@@ -3401,6 +3412,8 @@ class ServingEndpoint:
             body["tags"] = [v.as_dict() for v in self.tags]
         if self.task is not None:
             body["task"] = self.task
+        if self.usage_policy_id is not None:
+            body["usage_policy_id"] = self.usage_policy_id
         return body
 
     def as_shallow_dict(self) -> dict:
@@ -3430,6 +3443,8 @@ class ServingEndpoint:
             body["tags"] = self.tags
         if self.task is not None:
             body["task"] = self.task
+        if self.usage_policy_id is not None:
+            body["usage_policy_id"] = self.usage_policy_id
         return body
 
     @classmethod
@@ -3448,6 +3463,7 @@ class ServingEndpoint:
             state=_from_dict(d, "state", EndpointState),
             tags=_repeated_dict(d, "tags", EndpointTag),
             task=d.get("task", None),
+            usage_policy_id=d.get("usage_policy_id", None),
         )
 
 
@@ -4474,6 +4490,7 @@ class ServingEndpointsAPI:
         self,
         name: str,
         *,
+        client_request_id: Optional[str] = None,
         dataframe_records: Optional[List[Any]] = None,
         dataframe_split: Optional[DataframeSplitInput] = None,
         extra_params: Optional[Dict[str, str]] = None,
@@ -4487,11 +4504,15 @@ class ServingEndpointsAPI:
         stop: Optional[List[str]] = None,
         stream: Optional[bool] = None,
         temperature: Optional[float] = None,
+        usage_context: Optional[Dict[str, str]] = None,
     ) -> QueryEndpointResponse:
         """Query a serving endpoint
 
         :param name: str
           The name of the serving endpoint. This field is required and is provided via the path parameter.
+        :param client_request_id: str (optional)
+          Optional user-provided request identifier that will be recorded in the inference table and the usage
+          tracking table.
         :param dataframe_records: List[Any] (optional)
           Pandas Dataframe input in the records orientation.
         :param dataframe_split: :class:`DataframeSplitInput` (optional)
@@ -4533,10 +4554,14 @@ class ServingEndpointsAPI:
           The temperature field used ONLY for __completions__ and __chat external & foundation model__ serving
           endpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with
           other chat/completions query fields.
+        :param usage_context: Dict[str,str] (optional)
+          Optional user-provided context that will be recorded in the usage tracking table.
 
         :returns: :class:`QueryEndpointResponse`
         """
         body = {}
+        if client_request_id is not None:
+            body["client_request_id"] = client_request_id
         if dataframe_records is not None:
             body["dataframe_records"] = [v for v in dataframe_records]
         if dataframe_split is not None:
@@ -4563,6 +4588,8 @@ class ServingEndpointsAPI:
             body["stream"] = stream
         if temperature is not None:
             body["temperature"] = temperature
+        if usage_context is not None:
+            body["usage_context"] = usage_context
         headers = {
             "Accept": "application/json",
             "Content-Type": "application/json",
@@ -4777,6 +4804,7 @@ class ServingEndpointsDataPlaneAPI:
         self,
         name: str,
         *,
+        client_request_id: Optional[str] = None,
         dataframe_records: Optional[List[Any]] = None,
         dataframe_split: Optional[DataframeSplitInput] = None,
         extra_params: Optional[Dict[str, str]] = None,
@@ -4790,11 +4818,15 @@ class ServingEndpointsDataPlaneAPI:
         stop: Optional[List[str]] = None,
         stream: Optional[bool] = None,
         temperature: Optional[float] = None,
+        usage_context: Optional[Dict[str, str]] = None,
     ) -> QueryEndpointResponse:
         """Query a serving endpoint
 
         :param name: str
           The name of the serving endpoint. This field is required and is provided via the path parameter.
+        :param client_request_id: str (optional)
+          Optional user-provided request identifier that will be recorded in the inference table and the usage
+          tracking table.
         :param dataframe_records: List[Any] (optional)
           Pandas Dataframe input in the records orientation.
         :param dataframe_split: :class:`DataframeSplitInput` (optional)
@@ -4836,10 +4868,14 @@ class ServingEndpointsDataPlaneAPI:
           The temperature field used ONLY for __completions__ and __chat external & foundation model__ serving
           endpoints. This is a float between 0.0 and 2.0 with a default of 1.0 and should only be used with
           other chat/completions query fields.
+        :param usage_context: Dict[str,str] (optional)
+          Optional user-provided context that will be recorded in the usage tracking table.
 
         :returns: :class:`QueryEndpointResponse`
         """
         body = {}
+        if client_request_id is not None:
+            body["client_request_id"] = client_request_id
         if dataframe_records is not None:
             body["dataframe_records"] = [v for v in dataframe_records]
         if dataframe_split is not None:
@@ -4866,6 +4902,8 @@ class ServingEndpointsDataPlaneAPI:
             body["stream"] = stream
         if temperature is not None:
             body["temperature"] = temperature
+        if usage_context is not None:
+            body["usage_context"] = usage_context
         data_plane_info = self._data_plane_info_query(
             name=name,
         )

databricks/sdk/service/settings.py

@@ -4617,6 +4617,18 @@ class SetStatusResponse:
 
 @dataclass
 class SlackConfig:
+    channel_id: Optional[str] = None
+    """[Input-Only] Slack channel ID for notifications."""
+
+    channel_id_set: Optional[bool] = None
+    """[Output-Only] Whether channel ID is set."""
+
+    oauth_token: Optional[str] = None
+    """[Input-Only] OAuth token for Slack authentication."""
+
+    oauth_token_set: Optional[bool] = None
+    """[Output-Only] Whether OAuth token is set."""
+
     url: Optional[str] = None
     """[Input-Only] URL for Slack destination."""
 
@@ -4626,6 +4638,14 @@ class SlackConfig:
     def as_dict(self) -> dict:
         """Serializes the SlackConfig into a dictionary suitable for use as a JSON request body."""
         body = {}
+        if self.channel_id is not None:
+            body["channel_id"] = self.channel_id
+        if self.channel_id_set is not None:
+            body["channel_id_set"] = self.channel_id_set
+        if self.oauth_token is not None:
+            body["oauth_token"] = self.oauth_token
+        if self.oauth_token_set is not None:
+            body["oauth_token_set"] = self.oauth_token_set
         if self.url is not None:
             body["url"] = self.url
         if self.url_set is not None:
@@ -4635,6 +4655,14 @@ class SlackConfig:
     def as_shallow_dict(self) -> dict:
         """Serializes the SlackConfig into a shallow dictionary of its immediate attributes."""
         body = {}
+        if self.channel_id is not None:
+            body["channel_id"] = self.channel_id
+        if self.channel_id_set is not None:
+            body["channel_id_set"] = self.channel_id_set
+        if self.oauth_token is not None:
+            body["oauth_token"] = self.oauth_token
+        if self.oauth_token_set is not None:
+            body["oauth_token_set"] = self.oauth_token_set
         if self.url is not None:
             body["url"] = self.url
         if self.url_set is not None:
@@ -4644,7 +4672,14 @@ class SlackConfig:
     @classmethod
     def from_dict(cls, d: Dict[str, Any]) -> SlackConfig:
         """Deserializes the SlackConfig from a dictionary."""
-        return cls(url=d.get("url", None), url_set=d.get("url_set", None))
+        return cls(
+            channel_id=d.get("channel_id", None),
+            channel_id_set=d.get("channel_id_set", None),
+            oauth_token=d.get("oauth_token", None),
+            oauth_token_set=d.get("oauth_token_set", None),
+            url=d.get("url", None),
+            url_set=d.get("url_set", None),
+        )
 
 
 @dataclass