databricks-sdk 0.55.0__py3-none-any.whl → 0.57.0__py3-none-any.whl

databricks/sdk/service/cleanrooms.py

@@ -138,6 +138,10 @@ class CleanRoomAsset:
     asset_type: Optional[CleanRoomAssetAssetType] = None
     """The type of the asset."""
 
+    clean_room_name: Optional[str] = None
+    """The name of the clean room this asset belongs to. This is an output-only field to ensure proper
+    resource identification."""
+
     foreign_table: Optional[CleanRoomAssetForeignTable] = None
     """Foreign table details available to all collaborators of the clean room. Present if and only if
     **asset_type** is **FOREIGN_TABLE**"""
@@ -192,6 +196,8 @@ class CleanRoomAsset:
             body["added_at"] = self.added_at
         if self.asset_type is not None:
             body["asset_type"] = self.asset_type.value
+        if self.clean_room_name is not None:
+            body["clean_room_name"] = self.clean_room_name
         if self.foreign_table:
             body["foreign_table"] = self.foreign_table.as_dict()
         if self.foreign_table_local_details:
@@ -223,6 +229,8 @@ class CleanRoomAsset:
             body["added_at"] = self.added_at
         if self.asset_type is not None:
             body["asset_type"] = self.asset_type
+        if self.clean_room_name is not None:
+            body["clean_room_name"] = self.clean_room_name
         if self.foreign_table:
             body["foreign_table"] = self.foreign_table
         if self.foreign_table_local_details:
@@ -253,6 +261,7 @@ class CleanRoomAsset:
         return cls(
             added_at=d.get("added_at", None),
             asset_type=_enum(d, "asset_type", CleanRoomAssetAssetType),
+            clean_room_name=d.get("clean_room_name", None),
             foreign_table=_from_dict(d, "foreign_table", CleanRoomAssetForeignTable),
             foreign_table_local_details=_from_dict(
                 d, "foreign_table_local_details", CleanRoomAssetForeignTableLocalDetails
@@ -1213,9 +1222,7 @@ class CleanRoomAssetsAPI:
         self._api = api_client
 
     def create(self, clean_room_name: str, asset: CleanRoomAsset) -> CleanRoomAsset:
-        """Create an asset.
-
-        Create a clean room asset —share an asset like a notebook or table into the clean room. For each UC
+        """Create a clean room asset —share an asset like a notebook or table into the clean room. For each UC
         asset that is added through this method, the clean room owner must also have enough privilege on the
         asset to consume it. The privilege must be maintained indefinitely for the clean room to be able to
         access the asset. Typically, you should use a group as the clean room owner.
@@ -1236,16 +1243,14 @@ class CleanRoomAssetsAPI:
         res = self._api.do("POST", f"/api/2.0/clean-rooms/{clean_room_name}/assets", body=body, headers=headers)
         return CleanRoomAsset.from_dict(res)
 
-    def delete(self, clean_room_name: str, asset_type: CleanRoomAssetAssetType, asset_full_name: str):
-        """Delete an asset.
-
-        Delete a clean room asset - unshare/remove the asset from the clean room
+    def delete(self, clean_room_name: str, asset_type: CleanRoomAssetAssetType, name: str):
+        """Delete a clean room asset - unshare/remove the asset from the clean room
 
         :param clean_room_name: str
           Name of the clean room.
         :param asset_type: :class:`CleanRoomAssetAssetType`
           The type of the asset.
-        :param asset_full_name: str
+        :param name: str
           The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.
 
 
@@ -1256,21 +1261,17 @@ class CleanRoomAssetsAPI:
         }
 
         self._api.do(
-            "DELETE",
-            f"/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type.value}/{asset_full_name}",
-            headers=headers,
+            "DELETE", f"/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type.value}/{name}", headers=headers
         )
 
-    def get(self, clean_room_name: str, asset_type: CleanRoomAssetAssetType, asset_full_name: str) -> CleanRoomAsset:
-        """Get an asset.
-
-        Get the details of a clean room asset by its type and full name.
+    def get(self, clean_room_name: str, asset_type: CleanRoomAssetAssetType, name: str) -> CleanRoomAsset:
+        """Get the details of a clean room asset by its type and full name.
 
         :param clean_room_name: str
           Name of the clean room.
         :param asset_type: :class:`CleanRoomAssetAssetType`
           The type of the asset.
-        :param asset_full_name: str
+        :param name: str
           The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.
 
         :returns: :class:`CleanRoomAsset`
@@ -1281,9 +1282,7 @@ class CleanRoomAssetsAPI:
         }
 
         res = self._api.do(
-            "GET",
-            f"/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type.value}/{asset_full_name}",
-            headers=headers,
+            "GET", f"/api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type.value}/{name}", headers=headers
         )
         return CleanRoomAsset.from_dict(res)
 
@@ -1317,9 +1316,7 @@ class CleanRoomAssetsAPI:
     def update(
         self, clean_room_name: str, asset_type: CleanRoomAssetAssetType, name: str, asset: CleanRoomAsset
     ) -> CleanRoomAsset:
-        """Update an asset.
-
-        Update a clean room asset. For example, updating the content of a notebook; changing the shared
+        """Update a clean room asset. For example, updating the content of a notebook; changing the shared
         partitions of a table; etc.
 
         :param clean_room_name: str
@@ -1368,9 +1365,7 @@ class CleanRoomTaskRunsAPI:
         page_size: Optional[int] = None,
         page_token: Optional[str] = None,
     ) -> Iterator[CleanRoomNotebookTaskRun]:
-        """List notebook task runs.
-
-        List all the historical notebook task runs in a clean room.
+        """List all the historical notebook task runs in a clean room.
 
         :param clean_room_name: str
           Name of the clean room.
@@ -1414,9 +1409,7 @@ class CleanRoomsAPI:
         self._api = api_client
 
     def create(self, clean_room: CleanRoom) -> CleanRoom:
-        """Create a clean room.
-
-        Create a new clean room with the specified collaborators. This method is asynchronous; the returned
+        """Create a new clean room with the specified collaborators. This method is asynchronous; the returned
         name field inside the clean_room field can be used to poll the clean room status, using the
         :method:cleanrooms/get method. When this method returns, the clean room will be in a PROVISIONING
         state, with only name, owner, comment, created_at and status populated. The clean room will be usable
@@ -1440,9 +1433,7 @@ class CleanRoomsAPI:
     def create_output_catalog(
         self, clean_room_name: str, output_catalog: CleanRoomOutputCatalog
     ) -> CreateCleanRoomOutputCatalogResponse:
-        """Create an output catalog.
-
-        Create the output catalog of the clean room.
+        """Create the output catalog of the clean room.
 
         :param clean_room_name: str
           Name of the clean room.
@@ -1462,9 +1453,7 @@ class CleanRoomsAPI:
         return CreateCleanRoomOutputCatalogResponse.from_dict(res)
 
     def delete(self, name: str):
-        """Delete a clean room.
-
-        Delete a clean room. After deletion, the clean room will be removed from the metastore. If the other
+        """Delete a clean room. After deletion, the clean room will be removed from the metastore. If the other
         collaborators have not deleted the clean room, they will still have the clean room in their metastore,
         but it will be in a DELETED state and no operations other than deletion can be performed on it.
 
@@ -1481,9 +1470,7 @@ class CleanRoomsAPI:
         self._api.do("DELETE", f"/api/2.0/clean-rooms/{name}", headers=headers)
 
     def get(self, name: str) -> CleanRoom:
-        """Get a clean room.
-
-        Get the details of a clean room given its name.
+        """Get the details of a clean room given its name.
 
         :param name: str
 
@@ -1498,9 +1485,7 @@ class CleanRoomsAPI:
         return CleanRoom.from_dict(res)
 
     def list(self, *, page_size: Optional[int] = None, page_token: Optional[str] = None) -> Iterator[CleanRoom]:
-        """List clean rooms.
-
-        Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are
+        """Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are
         returned.
 
         :param page_size: int (optional)
@@ -1530,9 +1515,7 @@ class CleanRoomsAPI:
             query["page_token"] = json["next_page_token"]
 
     def update(self, name: str, *, clean_room: Optional[CleanRoom] = None) -> CleanRoom:
-        """Update a clean room.
-
-        Update a clean room. The caller must be the owner of the clean room, have **MODIFY_CLEAN_ROOM**
+        """Update a clean room. The caller must be the owner of the clean room, have **MODIFY_CLEAN_ROOM**
         privilege, or be metastore admin.
 
         When the caller is a metastore admin, only the __owner__ field can be updated.