w.clean_room_assets: Assets

class databricks.sdk.service.cleanrooms.CleanRoomAssetsAPI

Clean room assets are data and code objects — Tables, volumes, and notebooks that are shared with the clean room.

create(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 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.

Parameters:

  • clean_room_name – str Name of the clean room.

  • asset – CleanRoomAsset Metadata of the clean room asset

Returns:

CleanRoomAsset

delete(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

Parameters:

  • clean_room_name – str Name of the clean room.

  • asset_type – CleanRoomAssetAssetType The type of the asset.

  • asset_full_name – str The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.

get(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.

Parameters:

  • clean_room_name – str Name of the clean room.

  • asset_type – CleanRoomAssetAssetType The type of the asset.

  • asset_full_name – str The fully qualified name of the asset, it is same as the name field in CleanRoomAsset.

Returns:

CleanRoomAsset

list(clean_room_name: str [, page_token: Optional[str]]) → Iterator[CleanRoomAsset]

List assets.

Parameters:

  • clean_room_name – str Name of the clean room.

  • page_token – str (optional) Opaque pagination token to go to next page based on previous query.

Returns:

Iterator over CleanRoomAsset

update(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 partitions of a table; etc.

Parameters:

  • clean_room_name – str Name of the clean room.

  • asset_type – CleanRoomAssetAssetType The type of the asset.

  • name –

    str A fully qualified name that uniquely identifies the asset within the clean room. This is also the name displayed in the clean room UI.

    For UC securable assets (tables, volumes, etc.), the format is shared_catalog.*shared_schema*.*asset_name*

    For notebooks, the name is the notebook file name.

  • asset – CleanRoomAsset Metadata of the clean room asset

Returns:

CleanRoomAsset