databricks-sdk 0.58.0__py3-none-any.whl → 0.59.0__py3-none-any.whl

databricks/sdk/__init__.py

@@ -97,7 +97,8 @@ from databricks.sdk.service.oauth2 import (AccountFederationPolicyAPI,
                                            OAuthPublishedAppsAPI,
                                            PublishedAppIntegrationAPI,
                                            ServicePrincipalFederationPolicyAPI,
-                                           ServicePrincipalSecretsAPI)
+                                           ServicePrincipalSecretsAPI,
+                                           ServicePrincipalSecretsProxyAPI)
 from databricks.sdk.service.pipelines import PipelinesAPI
 from databricks.sdk.service.provisioning import (CredentialsAPI,
                                                  EncryptionKeysAPI,
@@ -113,10 +114,11 @@ from databricks.sdk.service.settings import (
     AibiDashboardEmbeddingApprovedDomainsAPI, AutomaticClusterUpdateAPI,
     ComplianceSecurityProfileAPI, CredentialsManagerAPI,
     CspEnablementAccountAPI, DashboardEmailSubscriptionsAPI,
-    DefaultNamespaceAPI, DisableLegacyAccessAPI, DisableLegacyDbfsAPI,
-    DisableLegacyFeaturesAPI, EnableExportNotebookAPI, EnableIpAccessListsAPI,
-    EnableNotebookTableClipboardAPI, EnableResultsDownloadingAPI,
-    EnhancedSecurityMonitoringAPI, EsmEnablementAccountAPI, IpAccessListsAPI,
+    DefaultNamespaceAPI, DefaultWarehouseIdAPI, DisableLegacyAccessAPI,
+    DisableLegacyDbfsAPI, DisableLegacyFeaturesAPI, EnableExportNotebookAPI,
+    EnableIpAccessListsAPI, EnableNotebookTableClipboardAPI,
+    EnableResultsDownloadingAPI, EnhancedSecurityMonitoringAPI,
+    EsmEnablementAccountAPI, IpAccessListsAPI,
     LlmProxyPartnerPoweredAccountAPI, LlmProxyPartnerPoweredEnforceAPI,
     LlmProxyPartnerPoweredWorkspaceAPI, NetworkConnectivityAPI,
     NetworkPoliciesAPI, NotificationDestinationsAPI, PersonalComputeAPI,
@@ -323,6 +325,7 @@ class WorkspaceClient:
         self._resource_quotas = pkg_catalog.ResourceQuotasAPI(self._api_client)
         self._schemas = pkg_catalog.SchemasAPI(self._api_client)
         self._secrets = pkg_workspace.SecretsAPI(self._api_client)
+        self._service_principal_secrets_proxy = pkg_oauth2.ServicePrincipalSecretsProxyAPI(self._api_client)
         self._service_principals = pkg_iam.ServicePrincipalsAPI(self._api_client)
         self._serving_endpoints = serving_endpoints
         serving_endpoints_data_plane_token_source = DataPlaneTokenSource(
@@ -788,6 +791,11 @@ class WorkspaceClient:
         """The Secrets API allows you to manage secrets, secret scopes, and access permissions."""
         return self._secrets
 
+    @property
+    def service_principal_secrets_proxy(self) -> pkg_oauth2.ServicePrincipalSecretsProxyAPI:
+        """These APIs enable administrators to manage service principal secrets at the workspace level."""
+        return self._service_principal_secrets_proxy
+
     @property
     def service_principals(self) -> pkg_iam.ServicePrincipalsAPI:
         """Identities for use with jobs, automated tools, and systems such as scripts, apps, and CI/CD platforms."""

databricks/sdk/service/aibuilder.py

@@ -15,73 +15,6 @@ _LOG = logging.getLogger("databricks.sdk")
 # all definitions in this file are in alphabetical order
 
 
-@dataclass
-class CancelCustomLlmOptimizationRunRequest:
-    id: Optional[str] = None
-
-
-@dataclass
-class CreateCustomLlmRequest:
-    name: str
-    """Name of the custom LLM. Only alphanumeric characters and dashes allowed."""
-
-    instructions: str
-    """Instructions for the custom LLM to follow"""
-
-    agent_artifact_path: Optional[str] = None
-    """Optional: UC path for agent artifacts. If you are using a dataset that you only have read
-    permissions, please provide a destination path where you have write permissions. Please provide
-    this in catalog.schema format."""
-
-    datasets: Optional[List[Dataset]] = None
-    """Datasets used for training and evaluating the model, not for inference. Currently, only 1
-    dataset is accepted."""
-
-    guidelines: Optional[List[str]] = None
-    """Guidelines for the custom LLM to adhere to"""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateCustomLlmRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.agent_artifact_path is not None:
-            body["agent_artifact_path"] = self.agent_artifact_path
-        if self.datasets:
-            body["datasets"] = [v.as_dict() for v in self.datasets]
-        if self.guidelines:
-            body["guidelines"] = [v for v in self.guidelines]
-        if self.instructions is not None:
-            body["instructions"] = self.instructions
-        if self.name is not None:
-            body["name"] = self.name
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateCustomLlmRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.agent_artifact_path is not None:
-            body["agent_artifact_path"] = self.agent_artifact_path
-        if self.datasets:
-            body["datasets"] = self.datasets
-        if self.guidelines:
-            body["guidelines"] = self.guidelines
-        if self.instructions is not None:
-            body["instructions"] = self.instructions
-        if self.name is not None:
-            body["name"] = self.name
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateCustomLlmRequest:
-        """Deserializes the CreateCustomLlmRequest from a dictionary."""
-        return cls(
-            agent_artifact_path=d.get("agent_artifact_path", None),
-            datasets=_repeated_dict(d, "datasets", Dataset),
-            guidelines=d.get("guidelines", None),
-            instructions=d.get("instructions", None),
-            name=d.get("name", None),
-        )
-
-
 @dataclass
 class CustomLlm:
     name: str
@@ -203,12 +136,6 @@ class Dataset:
         return cls(table=_from_dict(d, "table", Table))
 
 
-@dataclass
-class StartCustomLlmOptimizationRunRequest:
-    id: Optional[str] = None
-    """The Id of the tile."""
-
-
 class State(Enum):
     """States of Custom LLM optimization lifecycle."""
 
@@ -263,60 +190,6 @@ class Table:
         )
 
 
-@dataclass
-class UpdateCustomLlmRequest:
-    custom_llm: CustomLlm
-    """The CustomLlm containing the fields which should be updated."""
-
-    update_mask: str
-    """The list of the CustomLlm fields to update. These should correspond to the values (or lack
-    thereof) present in `custom_llm`.
-    
-    The field mask must be a single string, with multiple fields separated by commas (no spaces).
-    The field path is relative to the resource object, using a dot (`.`) to navigate sub-fields
-    (e.g., `author.given_name`). Specification of elements in sequence or map fields is not allowed,
-    as only the entire collection field can be specified. Field names must exactly match the
-    resource field names.
-    
-    A field mask of `*` indicates full replacement. It’s recommended to always explicitly list the
-    fields being updated and avoid using `*` wildcards, as it can lead to unintended results if the
-    API changes in the future."""
-
-    id: Optional[str] = None
-    """The id of the custom llm"""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateCustomLlmRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.custom_llm:
-            body["custom_llm"] = self.custom_llm.as_dict()
-        if self.id is not None:
-            body["id"] = self.id
-        if self.update_mask is not None:
-            body["update_mask"] = self.update_mask
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateCustomLlmRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.custom_llm:
-            body["custom_llm"] = self.custom_llm
-        if self.id is not None:
-            body["id"] = self.id
-        if self.update_mask is not None:
-            body["update_mask"] = self.update_mask
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateCustomLlmRequest:
-        """Deserializes the UpdateCustomLlmRequest from a dictionary."""
-        return cls(
-            custom_llm=_from_dict(d, "custom_llm", CustomLlm),
-            id=d.get("id", None),
-            update_mask=d.get("update_mask", None),
-        )
-
-
 class AiBuilderAPI:
     """The Custom LLMs service manages state and powers the UI for the Custom LLM product."""
 

databricks/sdk/service/apps.py

@@ -602,45 +602,13 @@ class AppPermissionsDescription:
         )
 
 
-@dataclass
-class AppPermissionsRequest:
-    access_control_list: Optional[List[AppAccessControlRequest]] = None
-
-    app_name: Optional[str] = None
-    """The app for which to get or manage permissions."""
-
-    def as_dict(self) -> dict:
-        """Serializes the AppPermissionsRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.access_control_list:
-            body["access_control_list"] = [v.as_dict() for v in self.access_control_list]
-        if self.app_name is not None:
-            body["app_name"] = self.app_name
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the AppPermissionsRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.access_control_list:
-            body["access_control_list"] = self.access_control_list
-        if self.app_name is not None:
-            body["app_name"] = self.app_name
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> AppPermissionsRequest:
-        """Deserializes the AppPermissionsRequest from a dictionary."""
-        return cls(
-            access_control_list=_repeated_dict(d, "access_control_list", AppAccessControlRequest),
-            app_name=d.get("app_name", None),
-        )
-
-
 @dataclass
 class AppResource:
     name: str
     """Name of the App Resource."""
 
+    database: Optional[AppResourceDatabase] = None
+
     description: Optional[str] = None
     """Description of the App Resource."""
 
@@ -657,6 +625,8 @@ class AppResource:
     def as_dict(self) -> dict:
         """Serializes the AppResource into a dictionary suitable for use as a JSON request body."""
         body = {}
+        if self.database:
+            body["database"] = self.database.as_dict()
         if self.description is not None:
             body["description"] = self.description
         if self.job:
@@ -676,6 +646,8 @@ class AppResource:
     def as_shallow_dict(self) -> dict:
         """Serializes the AppResource into a shallow dictionary of its immediate attributes."""
         body = {}
+        if self.database:
+            body["database"] = self.database
         if self.description is not None:
             body["description"] = self.description
         if self.job:
@@ -696,6 +668,7 @@ class AppResource:
     def from_dict(cls, d: Dict[str, Any]) -> AppResource:
         """Deserializes the AppResource from a dictionary."""
         return cls(
+            database=_from_dict(d, "database", AppResourceDatabase),
             description=d.get("description", None),
             job=_from_dict(d, "job", AppResourceJob),
             name=d.get("name", None),
@@ -706,6 +679,51 @@ class AppResource:
         )
 
 
+@dataclass
+class AppResourceDatabase:
+    instance_name: str
+
+    database_name: str
+
+    permission: AppResourceDatabaseDatabasePermission
+
+    def as_dict(self) -> dict:
+        """Serializes the AppResourceDatabase into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.database_name is not None:
+            body["database_name"] = self.database_name
+        if self.instance_name is not None:
+            body["instance_name"] = self.instance_name
+        if self.permission is not None:
+            body["permission"] = self.permission.value
+        return body
+
+    def as_shallow_dict(self) -> dict:
+        """Serializes the AppResourceDatabase into a shallow dictionary of its immediate attributes."""
+        body = {}
+        if self.database_name is not None:
+            body["database_name"] = self.database_name
+        if self.instance_name is not None:
+            body["instance_name"] = self.instance_name
+        if self.permission is not None:
+            body["permission"] = self.permission
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> AppResourceDatabase:
+        """Deserializes the AppResourceDatabase from a dictionary."""
+        return cls(
+            database_name=d.get("database_name", None),
+            instance_name=d.get("instance_name", None),
+            permission=_enum(d, "permission", AppResourceDatabaseDatabasePermission),
+        )
+
+
+class AppResourceDatabaseDatabasePermission(Enum):
+
+    CAN_CONNECT_AND_CREATE = "CAN_CONNECT_AND_CREATE"
+
+
 @dataclass
 class AppResourceJob:
     id: str
@@ -1109,18 +1127,6 @@ class ListAppsResponse:
         return cls(apps=_repeated_dict(d, "apps", App), next_page_token=d.get("next_page_token", None))
 
 
-@dataclass
-class StartAppRequest:
-    name: Optional[str] = None
-    """The name of the app."""
-
-
-@dataclass
-class StopAppRequest:
-    name: Optional[str] = None
-    """The name of the app."""
-
-
 class AppsAPI:
     """Apps run directly on a customer’s Databricks instance, integrate with their data, use and extend
     Databricks services, and enable users to interact through single sign-on."""

databricks/sdk/service/billing.py

@@ -416,41 +416,6 @@ class BudgetPolicy:
         )
 
 
-@dataclass
-class CreateBillingUsageDashboardRequest:
-    dashboard_type: Optional[UsageDashboardType] = None
-    """Workspace level usage dashboard shows usage data for the specified workspace ID. Global level
-    usage dashboard shows usage data for all workspaces in the account."""
-
-    workspace_id: Optional[int] = None
-    """The workspace ID of the workspace in which the usage dashboard is created."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateBillingUsageDashboardRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.dashboard_type is not None:
-            body["dashboard_type"] = self.dashboard_type.value
-        if self.workspace_id is not None:
-            body["workspace_id"] = self.workspace_id
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateBillingUsageDashboardRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.dashboard_type is not None:
-            body["dashboard_type"] = self.dashboard_type
-        if self.workspace_id is not None:
-            body["workspace_id"] = self.workspace_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateBillingUsageDashboardRequest:
-        """Deserializes the CreateBillingUsageDashboardRequest from a dictionary."""
-        return cls(
-            dashboard_type=_enum(d, "dashboard_type", UsageDashboardType), workspace_id=d.get("workspace_id", None)
-        )
-
-
 @dataclass
 class CreateBillingUsageDashboardResponse:
     dashboard_id: Optional[str] = None
@@ -628,31 +593,6 @@ class CreateBudgetConfigurationBudgetAlertConfigurations:
         )
 
 
-@dataclass
-class CreateBudgetConfigurationRequest:
-    budget: CreateBudgetConfigurationBudget
-    """Properties of the new budget configuration."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateBudgetConfigurationRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget.as_dict()
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateBudgetConfigurationRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateBudgetConfigurationRequest:
-        """Deserializes the CreateBudgetConfigurationRequest from a dictionary."""
-        return cls(budget=_from_dict(d, "budget", CreateBudgetConfigurationBudget))
-
-
 @dataclass
 class CreateBudgetConfigurationResponse:
     budget: Optional[BudgetConfiguration] = None
@@ -678,43 +618,6 @@ class CreateBudgetConfigurationResponse:
         return cls(budget=_from_dict(d, "budget", BudgetConfiguration))
 
 
-@dataclass
-class CreateBudgetPolicyRequest:
-    """A request to create a BudgetPolicy."""
-
-    policy: Optional[BudgetPolicy] = None
-    """The policy to create. `policy_id` needs to be empty as it will be generated `policy_name` must
-    be provided, custom_tags may need to be provided depending on the cloud provider. All other
-    fields are optional."""
-
-    request_id: Optional[str] = None
-    """A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is
-    recommended. This request is only idempotent if a `request_id` is provided."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateBudgetPolicyRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.policy:
-            body["policy"] = self.policy.as_dict()
-        if self.request_id is not None:
-            body["request_id"] = self.request_id
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateBudgetPolicyRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.policy:
-            body["policy"] = self.policy
-        if self.request_id is not None:
-            body["request_id"] = self.request_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateBudgetPolicyRequest:
-        """Deserializes the CreateBudgetPolicyRequest from a dictionary."""
-        return cls(policy=_from_dict(d, "policy", BudgetPolicy), request_id=d.get("request_id", None))
-
-
 @dataclass
 class CreateLogDeliveryConfigurationParams:
     """* Log Delivery Configuration"""
@@ -1500,38 +1403,6 @@ class UpdateBudgetConfigurationBudget:
         )
 
 
-@dataclass
-class UpdateBudgetConfigurationRequest:
-    budget: UpdateBudgetConfigurationBudget
-    """The updated budget. This will overwrite the budget specified by the budget ID."""
-
-    budget_id: Optional[str] = None
-    """The Databricks budget configuration ID."""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateBudgetConfigurationRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget.as_dict()
-        if self.budget_id is not None:
-            body["budget_id"] = self.budget_id
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateBudgetConfigurationRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.budget:
-            body["budget"] = self.budget
-        if self.budget_id is not None:
-            body["budget_id"] = self.budget_id
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateBudgetConfigurationRequest:
-        """Deserializes the UpdateBudgetConfigurationRequest from a dictionary."""
-        return cls(budget=_from_dict(d, "budget", UpdateBudgetConfigurationBudget), budget_id=d.get("budget_id", None))
-
-
 @dataclass
 class UpdateBudgetConfigurationResponse:
     budget: Optional[BudgetConfiguration] = None
@@ -1557,80 +1428,12 @@ class UpdateBudgetConfigurationResponse:
         return cls(budget=_from_dict(d, "budget", BudgetConfiguration))
 
 
-@dataclass
-class UpdateLogDeliveryConfigurationStatusRequest:
-    """* Update Log Delivery Configuration"""
-
-    status: LogDeliveryConfigStatus
-    """Status of log delivery configuration. Set to `ENABLED` (enabled) or `DISABLED` (disabled).
-    Defaults to `ENABLED`. You can [enable or disable the
-    configuration](#operation/patch-log-delivery-config-status) later. Deletion of a configuration
-    is not supported, so disable a log delivery configuration that is no longer needed."""
-
-    log_delivery_configuration_id: Optional[str] = None
-    """The log delivery configuration id of customer"""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateLogDeliveryConfigurationStatusRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.log_delivery_configuration_id is not None:
-            body["log_delivery_configuration_id"] = self.log_delivery_configuration_id
-        if self.status is not None:
-            body["status"] = self.status.value
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateLogDeliveryConfigurationStatusRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.log_delivery_configuration_id is not None:
-            body["log_delivery_configuration_id"] = self.log_delivery_configuration_id
-        if self.status is not None:
-            body["status"] = self.status
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateLogDeliveryConfigurationStatusRequest:
-        """Deserializes the UpdateLogDeliveryConfigurationStatusRequest from a dictionary."""
-        return cls(
-            log_delivery_configuration_id=d.get("log_delivery_configuration_id", None),
-            status=_enum(d, "status", LogDeliveryConfigStatus),
-        )
-
-
 class UsageDashboardType(Enum):
 
     USAGE_DASHBOARD_TYPE_GLOBAL = "USAGE_DASHBOARD_TYPE_GLOBAL"
     USAGE_DASHBOARD_TYPE_WORKSPACE = "USAGE_DASHBOARD_TYPE_WORKSPACE"
 
 
-@dataclass
-class WrappedCreateLogDeliveryConfiguration:
-    """* Properties of the new log delivery configuration."""
-
-    log_delivery_configuration: CreateLogDeliveryConfigurationParams
-
-    def as_dict(self) -> dict:
-        """Serializes the WrappedCreateLogDeliveryConfiguration into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.log_delivery_configuration:
-            body["log_delivery_configuration"] = self.log_delivery_configuration.as_dict()
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the WrappedCreateLogDeliveryConfiguration into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.log_delivery_configuration:
-            body["log_delivery_configuration"] = self.log_delivery_configuration
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> WrappedCreateLogDeliveryConfiguration:
-        """Deserializes the WrappedCreateLogDeliveryConfiguration from a dictionary."""
-        return cls(
-            log_delivery_configuration=_from_dict(d, "log_delivery_configuration", CreateLogDeliveryConfigurationParams)
-        )
-
-
 @dataclass
 class WrappedLogDeliveryConfiguration:
     log_delivery_configuration: Optional[LogDeliveryConfiguration] = None
@@ -1701,16 +1504,22 @@ class BillableUsageAPI:
 
     def download(self, start_month: str, end_month: str, *, personal_data: Optional[bool] = None) -> DownloadResponse:
         """Returns billable usage logs in CSV format for the specified account and date range. For the data
-        schema, see [CSV file schema]. Note that this method might take multiple minutes to complete.
+        schema, see:
+
+        - AWS: [CSV file schema]. - GCP: [CSV file schema].
+
+        Note that this method might take multiple minutes to complete.
 
         **Warning**: Depending on the queried date range, the number of workspaces in the account, the size of
         the response and the internet speed of the caller, this API may hit a timeout after a few minutes. If
         you experience this, try to mitigate by calling the API with narrower date ranges.
 
-        [CSV file schema]: https://docs.databricks.com/administration-guide/account-settings/usage-analysis.html#schema
+        [CSV file schema]: https://docs.gcp.databricks.com/administration-guide/account-settings/usage-analysis.html#csv-file-schema
 
         :param start_month: str
-          Format: `YYYY-MM`. First month to return billable usage logs for. This field is required.
+          Format specification for month in the format `YYYY-MM`. This is used to specify billable usage
+          `start_month` and `end_month` properties. **Note**: Billable usage logs are unavailable before March
+          2019 (`2019-03`).
         :param end_month: str
           Format: `YYYY-MM`. Last month to return billable usage logs for. This field is required.
         :param personal_data: bool (optional)