com.databricks.sdk.service.cleanrooms

Class CleanRoomsAPI

java.lang.Object

com.databricks.sdk.service.cleanrooms.CleanRoomsAPI

@Generated
public class CleanRoomsAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
CleanRoomsAPI(ApiClient apiClient) Regular-use constructor
CleanRoomsAPI(CleanRoomsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Wait<CleanRoom,CleanRoom>	create(CreateCleanRoomRequest request) Create a new clean room with the specified collaborators.
CreateCleanRoomOutputCatalogResponse	createOutputCatalog(CreateCleanRoomOutputCatalogRequest request) Create the output catalog of the clean room.
void	delete(DeleteCleanRoomRequest request) Delete a clean room.
void	delete(String name)
CleanRoom	get(GetCleanRoomRequest request) Get the details of a clean room given its name.
CleanRoom	get(String name)
CleanRoomsService	impl()
Iterable<CleanRoom>	list(ListCleanRoomsRequest request) Get a list of all clean rooms of the metastore.
CleanRoom	update(UpdateCleanRoomRequest request) Update a clean room.
CleanRoom	waitGetCleanRoomActive(String name)
CleanRoom	waitGetCleanRoomActive(String name, Duration timeout, Consumer<CleanRoom> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CleanRoomsAPI

public CleanRoomsAPI(ApiClient apiClient)

Regular-use constructor

CleanRoomsAPI

public CleanRoomsAPI(CleanRoomsService mock)

Constructor for mocks

Method Detail

waitGetCleanRoomActive

public CleanRoom waitGetCleanRoomActive(String name)
                                 throws TimeoutException

Throws:

TimeoutException

waitGetCleanRoomActive

public CleanRoom waitGetCleanRoomActive(String name,
                                        Duration timeout,
                                        Consumer<CleanRoom> callback)
                                 throws TimeoutException

Throws:

TimeoutException

create

public Wait<CleanRoom,CleanRoom> create(CreateCleanRoomRequest request)

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

public CreateCleanRoomOutputCatalogResponse createOutputCatalog(CreateCleanRoomOutputCatalogRequest request)

Create the output catalog of the clean room.

delete

public void delete(String name)

delete

public void delete(DeleteCleanRoomRequest request)

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

public CleanRoom get(String name)

get

public CleanRoom get(GetCleanRoomRequest request)

Get the details of a clean room given its name.

list

public Iterable<CleanRoom> list(ListCleanRoomsRequest request)

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

update

public CleanRoom update(UpdateCleanRoomRequest request)

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.

impl

public CleanRoomsService impl()