databricks-sdk 0.50.0__py3-none-any.whl → 0.51.0__py3-none-any.whl

databricks/sdk/service/jobs.py

@@ -576,10 +576,11 @@ class CleanRoomTaskRunState:
 
     life_cycle_state: Optional[CleanRoomTaskRunLifeCycleState] = None
     """A value indicating the run's current lifecycle state. This field is always available in the
-    response."""
+    response. Note: Additional states might be introduced in future releases."""
 
     result_state: Optional[CleanRoomTaskRunResultState] = None
-    """A value indicating the run's result. This field is only available for terminal lifecycle states."""
+    """A value indicating the run's result. This field is only available for terminal lifecycle states.
+    Note: Additional states might be introduced in future releases."""
 
     def as_dict(self) -> dict:
         """Serializes the CleanRoomTaskRunState into a dictionary suitable for use as a JSON request body."""
@@ -1023,8 +1024,8 @@ class CreateJob:
     """Job-level parameter definitions"""
 
     performance_target: Optional[PerformanceTarget] = None
-    """The performance mode on a serverless job. The performance target determines the level of compute
-    performance or cost-efficiency for the run.
+    """The performance mode on a serverless job. This field determines the level of compute performance
+    or cost-efficiency for the run.
     
     * `STANDARD`: Enables cost-efficient execution of serverless workloads. *
     `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
@@ -1322,11 +1323,14 @@ class DashboardTask:
     """Configures the Lakeview Dashboard job task type."""
 
     dashboard_id: Optional[str] = None
+    """The identifier of the dashboard to refresh."""
 
     subscription: Optional[Subscription] = None
+    """Optional: subscription configuration for sending the dashboard snapshot."""
 
     warehouse_id: Optional[str] = None
-    """The warehouse id to execute the dashboard with for the schedule"""
+    """Optional: The warehouse id to execute the dashboard with for the schedule. If not specified, the
+    default warehouse of the dashboard will be used."""
 
     def as_dict(self) -> dict:
         """Serializes the DashboardTask into a dictionary suitable for use as a JSON request body."""
@@ -2703,8 +2707,11 @@ class JobEnvironment:
     """The key of an environment. It has to be unique within a job."""
 
     spec: Optional[compute.Environment] = None
-    """The environment entity used to preserve serverless environment side panel and jobs' environment
-    for non-notebook task. In this minimal environment spec, only pip dependencies are supported."""
+    """The environment entity used to preserve serverless environment side panel, jobs' environment for
+    non-notebook task, and DLT's environment for classic and serverless pipelines. (Note: DLT uses a
+    copied version of the Environment proto below, at
+    //spark/pipelines/api/protos/copied/libraries-environments-copy.proto) In this minimal
+    environment spec, only pip dependencies are supported."""
 
     def as_dict(self) -> dict:
         """Serializes the JobEnvironment into a dictionary suitable for use as a JSON request body."""
@@ -3111,8 +3118,8 @@ class JobSettings:
     """Job-level parameter definitions"""
 
     performance_target: Optional[PerformanceTarget] = None
-    """The performance mode on a serverless job. The performance target determines the level of compute
-    performance or cost-efficiency for the run.
+    """The performance mode on a serverless job. This field determines the level of compute performance
+    or cost-efficiency for the run.
     
     * `STANDARD`: Enables cost-efficient execution of serverless workloads. *
     `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
@@ -4174,6 +4181,15 @@ class QueueSettings:
 
 @dataclass
 class RepairHistoryItem:
+    effective_performance_target: Optional[PerformanceTarget] = None
+    """The actual performance target used by the serverless run during execution. This can differ from
+    the client-set performance target on the request depending on whether the performance mode is
+    supported by the job type.
+    
+    * `STANDARD`: Enables cost-efficient execution of serverless workloads. *
+    `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
+    optimized cluster performance."""
+
     end_time: Optional[int] = None
     """The end time of the (repaired) run."""
 
@@ -4198,6 +4214,8 @@ class RepairHistoryItem:
     def as_dict(self) -> dict:
         """Serializes the RepairHistoryItem into a dictionary suitable for use as a JSON request body."""
         body = {}
+        if self.effective_performance_target is not None:
+            body["effective_performance_target"] = self.effective_performance_target.value
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.id is not None:
@@ -4217,6 +4235,8 @@ class RepairHistoryItem:
     def as_shallow_dict(self) -> dict:
         """Serializes the RepairHistoryItem into a shallow dictionary of its immediate attributes."""
         body = {}
+        if self.effective_performance_target is not None:
+            body["effective_performance_target"] = self.effective_performance_target
         if self.end_time is not None:
             body["end_time"] = self.end_time
         if self.id is not None:
@@ -4237,6 +4257,7 @@ class RepairHistoryItem:
     def from_dict(cls, d: Dict[str, Any]) -> RepairHistoryItem:
         """Deserializes the RepairHistoryItem from a dictionary."""
         return cls(
+            effective_performance_target=_enum(d, "effective_performance_target", PerformanceTarget),
             end_time=d.get("end_time", None),
             id=d.get("id", None),
             start_time=d.get("start_time", None),
@@ -4298,6 +4319,15 @@ class RepairRun:
     [Task parameter variables]: https://docs.databricks.com/jobs.html#parameter-variables
     [dbutils.widgets.get]: https://docs.databricks.com/dev-tools/databricks-utils.html"""
 
+    performance_target: Optional[PerformanceTarget] = None
+    """The performance mode on a serverless job. The performance target determines the level of compute
+    performance or cost-efficiency for the run. This field overrides the performance target defined
+    on the job level.
+    
+    * `STANDARD`: Enables cost-efficient execution of serverless workloads. *
+    `PERFORMANCE_OPTIMIZED`: Prioritizes fast startup and execution times through rapid scaling and
+    optimized cluster performance."""
+
     pipeline_params: Optional[PipelineParams] = None
     """Controls whether the pipeline should perform a full refresh"""
 
@@ -4364,6 +4394,8 @@ class RepairRun:
             body["latest_repair_id"] = self.latest_repair_id
         if self.notebook_params:
             body["notebook_params"] = self.notebook_params
+        if self.performance_target is not None:
+            body["performance_target"] = self.performance_target.value
         if self.pipeline_params:
             body["pipeline_params"] = self.pipeline_params.as_dict()
         if self.python_named_params:
@@ -4397,6 +4429,8 @@ class RepairRun:
             body["latest_repair_id"] = self.latest_repair_id
         if self.notebook_params:
             body["notebook_params"] = self.notebook_params
+        if self.performance_target is not None:
+            body["performance_target"] = self.performance_target
         if self.pipeline_params:
             body["pipeline_params"] = self.pipeline_params
         if self.python_named_params:
@@ -4426,6 +4460,7 @@ class RepairRun:
             job_parameters=d.get("job_parameters", None),
             latest_repair_id=d.get("latest_repair_id", None),
             notebook_params=d.get("notebook_params", None),
+            performance_target=_enum(d, "performance_target", PerformanceTarget),
             pipeline_params=_from_dict(d, "pipeline_params", PipelineParams),
             python_named_params=d.get("python_named_params", None),
             python_params=d.get("python_params", None),
@@ -6020,13 +6055,14 @@ class RunState:
 
     life_cycle_state: Optional[RunLifeCycleState] = None
     """A value indicating the run's current lifecycle state. This field is always available in the
-    response."""
+    response. Note: Additional states might be introduced in future releases."""
 
     queue_reason: Optional[str] = None
     """The reason indicating why the run was queued."""
 
     result_state: Optional[RunResultState] = None
-    """A value indicating the run's result. This field is only available for terminal lifecycle states."""
+    """A value indicating the run's result. This field is only available for terminal lifecycle states.
+    Note: Additional states might be introduced in future releases."""
 
     state_message: Optional[str] = None
     """A descriptive message for the current state. This field is unstructured, and its exact format is
@@ -6161,7 +6197,7 @@ class RunTask:
     does not support retries or notifications."""
 
     dashboard_task: Optional[DashboardTask] = None
-    """The task runs a DashboardTask when the `dashboard_task` field is present."""
+    """The task refreshes a dashboard and sends a snapshot to subscribers."""
 
     dbt_task: Optional[DbtTask] = None
     """The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task
@@ -7549,7 +7585,7 @@ class SubmitTask:
     does not support retries or notifications."""
 
     dashboard_task: Optional[DashboardTask] = None
-    """The task runs a DashboardTask when the `dashboard_task` field is present."""
+    """The task refreshes a dashboard and sends a snapshot to subscribers."""
 
     dbt_task: Optional[DbtTask] = None
     """The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task
@@ -7818,6 +7854,7 @@ class Subscription:
     """When true, the subscription will not send emails."""
 
     subscribers: Optional[List[SubscriptionSubscriber]] = None
+    """The list of subscribers to send the snapshot of the dashboard to."""
 
     def as_dict(self) -> dict:
         """Serializes the Subscription into a dictionary suitable for use as a JSON request body."""
@@ -7854,8 +7891,12 @@ class Subscription:
 @dataclass
 class SubscriptionSubscriber:
     destination_id: Optional[str] = None
+    """A snapshot of the dashboard will be sent to the destination when the `destination_id` field is
+    present."""
 
     user_name: Optional[str] = None
+    """A snapshot of the dashboard will be sent to the user's email when the `user_name` field is
+    present."""
 
     def as_dict(self) -> dict:
         """Serializes the SubscriptionSubscriber into a dictionary suitable for use as a JSON request body."""
@@ -7954,7 +7995,7 @@ class Task:
     does not support retries or notifications."""
 
     dashboard_task: Optional[DashboardTask] = None
-    """The task runs a DashboardTask when the `dashboard_task` field is present."""
+    """The task refreshes a dashboard and sends a snapshot to subscribers."""
 
     dbt_task: Optional[DbtTask] = None
     """The task runs one or more dbt commands when the `dbt_task` field is present. The dbt task
@@ -8459,7 +8500,7 @@ class TerminationCodeCode(Enum):
     invalid configuration. Refer to the state message for further details. * `CLOUD_FAILURE`: The
     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.
+    limit. * `DISABLED`: The run was never executed because it was disabled explicitly by the user.
 
     [Link]: https://kb.databricks.com/en_US/notebooks/too-many-execution-contexts-are-open-right-now"""
 
@@ -8468,6 +8509,7 @@ class TerminationCodeCode(Enum):
     CLOUD_FAILURE = "CLOUD_FAILURE"
     CLUSTER_ERROR = "CLUSTER_ERROR"
     CLUSTER_REQUEST_LIMIT_EXCEEDED = "CLUSTER_REQUEST_LIMIT_EXCEEDED"
+    DISABLED = "DISABLED"
     DRIVER_ERROR = "DRIVER_ERROR"
     FEATURE_DISABLED = "FEATURE_DISABLED"
     INTERNAL_ERROR = "INTERNAL_ERROR"
@@ -8523,7 +8565,7 @@ class TerminationDetails:
     invalid configuration. Refer to the state message for further details. * `CLOUD_FAILURE`: The
     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.
+    limit. * `DISABLED`: The run was never executed because it was disabled explicitly by the user.
     
     [Link]: https://kb.databricks.com/en_US/notebooks/too-many-execution-contexts-are-open-right-now"""
 
@@ -9140,8 +9182,8 @@ class JobsAPI:
         :param parameters: List[:class:`JobParameterDefinition`] (optional)
           Job-level parameter definitions
         :param performance_target: :class:`PerformanceTarget` (optional)
-          The performance mode on a serverless job. The performance target determines the level of compute
-          performance or cost-efficiency for the run.
+          The performance mode on a serverless job. This field determines the level of compute performance or
+          cost-efficiency for the run.
 
           * `STANDARD`: Enables cost-efficient execution of serverless workloads. * `PERFORMANCE_OPTIMIZED`:
           Prioritizes fast startup and execution times through rapid scaling and optimized cluster
@@ -9593,6 +9635,7 @@ class JobsAPI:
         job_parameters: Optional[Dict[str, str]] = None,
         latest_repair_id: Optional[int] = None,
         notebook_params: Optional[Dict[str, str]] = None,
+        performance_target: Optional[PerformanceTarget] = None,
         pipeline_params: Optional[PipelineParams] = None,
         python_named_params: Optional[Dict[str, str]] = None,
         python_params: Optional[List[str]] = None,
@@ -9643,6 +9686,14 @@ class JobsAPI:
 
           [Task parameter variables]: https://docs.databricks.com/jobs.html#parameter-variables
           [dbutils.widgets.get]: https://docs.databricks.com/dev-tools/databricks-utils.html
+        :param performance_target: :class:`PerformanceTarget` (optional)
+          The performance mode on a serverless job. The performance target determines the level of compute
+          performance or cost-efficiency for the run. This field overrides the performance target defined on
+          the job level.
+
+          * `STANDARD`: Enables cost-efficient execution of serverless workloads. * `PERFORMANCE_OPTIMIZED`:
+          Prioritizes fast startup and execution times through rapid scaling and optimized cluster
+          performance.
         :param pipeline_params: :class:`PipelineParams` (optional)
           Controls whether the pipeline should perform a full refresh
         :param python_named_params: Dict[str,str] (optional)
@@ -9703,6 +9754,8 @@ class JobsAPI:
             body["latest_repair_id"] = latest_repair_id
         if notebook_params is not None:
             body["notebook_params"] = notebook_params
+        if performance_target is not None:
+            body["performance_target"] = performance_target.value
         if pipeline_params is not None:
             body["pipeline_params"] = pipeline_params.as_dict()
         if python_named_params is not None:
@@ -9742,6 +9795,7 @@ class JobsAPI:
         job_parameters: Optional[Dict[str, str]] = None,
         latest_repair_id: Optional[int] = None,
         notebook_params: Optional[Dict[str, str]] = None,
+        performance_target: Optional[PerformanceTarget] = None,
         pipeline_params: Optional[PipelineParams] = None,
         python_named_params: Optional[Dict[str, str]] = None,
         python_params: Optional[List[str]] = None,
@@ -9758,6 +9812,7 @@ class JobsAPI:
             job_parameters=job_parameters,
             latest_repair_id=latest_repair_id,
             notebook_params=notebook_params,
+            performance_target=performance_target,
             pipeline_params=pipeline_params,
             python_named_params=python_named_params,
             python_params=python_params,

databricks/sdk/service/oauth2.py

@@ -1191,10 +1191,10 @@ class AccountFederationPolicyAPI:
     def __init__(self, api_client):
         self._api = api_client
 
-    def create(self, *, policy: Optional[FederationPolicy] = None, policy_id: Optional[str] = None) -> FederationPolicy:
+    def create(self, policy: FederationPolicy, *, policy_id: Optional[str] = None) -> FederationPolicy:
         """Create account federation policy.
 
-        :param policy: :class:`FederationPolicy` (optional)
+        :param policy: :class:`FederationPolicy`
         :param policy_id: str (optional)
           The identifier for the federation policy. The identifier must contain only lowercase alphanumeric
           characters, numbers, hyphens, and slashes. If unspecified, the id will be assigned by Databricks.
@@ -1284,13 +1284,13 @@ class AccountFederationPolicyAPI:
             query["page_token"] = json["next_page_token"]
 
     def update(
-        self, policy_id: str, *, policy: Optional[FederationPolicy] = None, update_mask: Optional[str] = None
+        self, policy_id: str, policy: FederationPolicy, *, update_mask: Optional[str] = None
     ) -> FederationPolicy:
         """Update account federation policy.
 
         :param policy_id: str
           The identifier for the federation policy.
-        :param policy: :class:`FederationPolicy` (optional)
+        :param policy: :class:`FederationPolicy`
         :param update_mask: str (optional)
           The field mask specifies which fields of the policy to update. To specify multiple fields in the
           field mask, use comma as the separator (no space). The special value '*' indicates that all fields
@@ -1758,13 +1758,13 @@ class ServicePrincipalFederationPolicyAPI:
         self._api = api_client
 
     def create(
-        self, service_principal_id: int, *, policy: Optional[FederationPolicy] = None, policy_id: Optional[str] = None
+        self, service_principal_id: int, policy: FederationPolicy, *, policy_id: Optional[str] = None
     ) -> FederationPolicy:
         """Create service principal federation policy.
 
         :param service_principal_id: int
           The service principal id for the federation policy.
-        :param policy: :class:`FederationPolicy` (optional)
+        :param policy: :class:`FederationPolicy`
         :param policy_id: str (optional)
           The identifier for the federation policy. The identifier must contain only lowercase alphanumeric
           characters, numbers, hyphens, and slashes. If unspecified, the id will be assigned by Databricks.
@@ -1869,12 +1869,7 @@ class ServicePrincipalFederationPolicyAPI:
             query["page_token"] = json["next_page_token"]
 
     def update(
-        self,
-        service_principal_id: int,
-        policy_id: str,
-        *,
-        policy: Optional[FederationPolicy] = None,
-        update_mask: Optional[str] = None,
+        self, service_principal_id: int, policy_id: str, policy: FederationPolicy, *, update_mask: Optional[str] = None
     ) -> FederationPolicy:
         """Update service principal federation policy.
 
@@ -1882,7 +1877,7 @@ class ServicePrincipalFederationPolicyAPI:
           The service principal id for the federation policy.
         :param policy_id: str
           The identifier for the federation policy.
-        :param policy: :class:`FederationPolicy` (optional)
+        :param policy: :class:`FederationPolicy`
         :param update_mask: str (optional)
           The field mask specifies which fields of the policy to update. To specify multiple fields in the
           field mask, use comma as the separator (no space). The special value '*' indicates that all fields

databricks/sdk/service/serving.py

@@ -2874,7 +2874,8 @@ class ServedEntityInput:
     """The workload size of the served entity. The workload size corresponds to a range of provisioned
     concurrency that the compute autoscales between. A single unit of provisioned concurrency can
     process one request at a time. Valid workload sizes are "Small" (4 - 4 provisioned concurrency),
-    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency). If
+    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency).
+    Additional custom workload sizes can also be used when available in the workspace. If
     scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size
     is 0."""
 
@@ -3014,7 +3015,8 @@ class ServedEntityOutput:
     """The workload size of the served entity. The workload size corresponds to a range of provisioned
     concurrency that the compute autoscales between. A single unit of provisioned concurrency can
     process one request at a time. Valid workload sizes are "Small" (4 - 4 provisioned concurrency),
-    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency). If
+    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency).
+    Additional custom workload sizes can also be used when available in the workspace. If
     scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size
     is 0."""
 
@@ -3204,11 +3206,12 @@ class ServedModelInput:
     model, this field defaults to external_model.name, with '.' and ':' replaced with '-', and if
     not specified for other entities, it defaults to entity_name-entity_version."""
 
-    workload_size: Optional[ServedModelInputWorkloadSize] = None
+    workload_size: Optional[str] = None
     """The workload size of the served entity. The workload size corresponds to a range of provisioned
     concurrency that the compute autoscales between. A single unit of provisioned concurrency can
     process one request at a time. Valid workload sizes are "Small" (4 - 4 provisioned concurrency),
-    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency). If
+    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency).
+    Additional custom workload sizes can also be used when available in the workspace. If
     scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size
     is 0."""
 
@@ -3240,7 +3243,7 @@ class ServedModelInput:
         if self.scale_to_zero_enabled is not None:
             body["scale_to_zero_enabled"] = self.scale_to_zero_enabled
         if self.workload_size is not None:
-            body["workload_size"] = self.workload_size.value
+            body["workload_size"] = self.workload_size
         if self.workload_type is not None:
             body["workload_type"] = self.workload_type.value
         return body
@@ -3282,18 +3285,11 @@ class ServedModelInput:
             model_version=d.get("model_version", None),
             name=d.get("name", None),
             scale_to_zero_enabled=d.get("scale_to_zero_enabled", None),
-            workload_size=_enum(d, "workload_size", ServedModelInputWorkloadSize),
+            workload_size=d.get("workload_size", None),
             workload_type=_enum(d, "workload_type", ServedModelInputWorkloadType),
         )
 
 
-class ServedModelInputWorkloadSize(Enum):
-
-    LARGE = "Large"
-    MEDIUM = "Medium"
-    SMALL = "Small"
-
-
 class ServedModelInputWorkloadType(Enum):
     """Please keep this in sync with with workload types in InferenceEndpointEntities.scala"""
 
@@ -3338,7 +3334,8 @@ class ServedModelOutput:
     """The workload size of the served entity. The workload size corresponds to a range of provisioned
     concurrency that the compute autoscales between. A single unit of provisioned concurrency can
     process one request at a time. Valid workload sizes are "Small" (4 - 4 provisioned concurrency),
-    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency). If
+    "Medium" (8 - 16 provisioned concurrency), and "Large" (16 - 64 provisioned concurrency).
+    Additional custom workload sizes can also be used when available in the workspace. If
     scale-to-zero is enabled, the lower bound of the provisioned concurrency for each workload size
     is 0."""