Package com.databricks.sdk.service.sharing

Class CleanRoomsAPI

java.lang.Object

com.databricks.sdk.service.sharing.CleanRoomsAPI

@Generated
public class CleanRoomsAPI
extends Object

A clean room is a secure, privacy-protecting environment where two or more parties can share sensitive enterprise data, including customer data, for measurements, insights, activation and other use cases.

To create clean rooms, you must be a metastore admin or a user with the **CREATE_CLEAN_ROOM** privilege.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CleanRoomInfo	create(CreateCleanRoom request)	Create a clean room.
CleanRoomInfo	create(String name, CentralCleanRoomInfo remoteDetailedInfo)
void	delete(DeleteCleanRoomRequest request)	Delete a clean room.
void	delete(String nameArg)
CleanRoomInfo	get(GetCleanRoomRequest request)	Get a clean room.
CleanRoomInfo	get(String nameArg)
CleanRoomsService	impl()
Iterable<CleanRoomInfo>	list()	List clean rooms.
CleanRoomInfo	update(UpdateCleanRoom request)	Update a clean room.
CleanRoomInfo	update(String nameArg)

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

create

public CleanRoomInfo create(String name,
                            CentralCleanRoomInfo remoteDetailedInfo)

create

public CleanRoomInfo create(CreateCleanRoom request)

Create a clean room.

Creates a new clean room with specified colaborators. The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the metastore.

delete

public void delete(String nameArg)

delete

public void delete(DeleteCleanRoomRequest request)

Delete a clean room.

Deletes a data object clean room from the metastore. The caller must be an owner of the clean room.

get

public CleanRoomInfo get(String nameArg)

get

public CleanRoomInfo get(GetCleanRoomRequest request)

Get a clean room.

Gets a data object clean room from the metastore. The caller must be a metastore admin or the owner of the clean room.

list

public Iterable<CleanRoomInfo> list()

List clean rooms.

Gets an array of data object clean rooms from the metastore. The caller must be a metastore admin or the owner of the clean room. There is no guarantee of a specific ordering of the elements in the array.

update

public CleanRoomInfo update(String nameArg)

update

public CleanRoomInfo update(UpdateCleanRoom request)

Update a clean room.

Updates the clean room with the changes and data objects in the request. The caller must be the owner of the clean room or a metastore admin.

When the caller is a metastore admin, only the __owner__ field can be updated.

In the case that the clean room name is changed **updateCleanRoom** requires that the caller is both the clean room owner and a metastore admin.

For each table that is added through this method, the clean room owner must also have **SELECT** privilege on the table. The privilege must be maintained indefinitely for recipients to be able to access the table. Typically, you should use a group as the clean room owner.

Table removals through **update** do not require additional privileges.

impl

public CleanRoomsService impl()