com.databricks.sdk.service.cleanrooms

Interface CleanRoomsService

@Generated
public interface CleanRoomsService

A clean room uses Delta Sharing and serverless compute to provide a secure and privacy-protecting environment where multiple parties can work together on sensitive enterprise data without direct access to each other's data.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
CleanRoom	create(CreateCleanRoomRequest createCleanRoomRequest) Create a new clean room with the specified collaborators.
CreateCleanRoomOutputCatalogResponse	createOutputCatalog(CreateCleanRoomOutputCatalogRequest createCleanRoomOutputCatalogRequest) Create the output catalog of the clean room.
void	delete(DeleteCleanRoomRequest deleteCleanRoomRequest) Delete a clean room.
CleanRoom	get(GetCleanRoomRequest getCleanRoomRequest) Get the details of a clean room given its name.
ListCleanRoomsResponse	list(ListCleanRoomsRequest listCleanRoomsRequest) Get a list of all clean rooms of the metastore.
CleanRoom	update(UpdateCleanRoomRequest updateCleanRoomRequest) Update a clean room.

Method Detail

create

CleanRoom create(CreateCleanRoomRequest createCleanRoomRequest)

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 once it enters an ACTIVE state.

The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the metastore.

createOutputCatalog

CreateCleanRoomOutputCatalogResponse createOutputCatalog(CreateCleanRoomOutputCatalogRequest createCleanRoomOutputCatalogRequest)

Create the output catalog of the clean room.

delete

void delete(DeleteCleanRoomRequest deleteCleanRoomRequest)

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.

get

CleanRoom get(GetCleanRoomRequest getCleanRoomRequest)

Get the details of a clean room given its name.

list

ListCleanRoomsResponse list(ListCleanRoomsRequest listCleanRoomsRequest)

Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are returned.

update

CleanRoom update(UpdateCleanRoomRequest updateCleanRoomRequest)

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.