Clean Rooms

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.cleanrooms module.

class databricks.sdk.service.cleanrooms.CleanRoom(access_restricted: 'Optional[CleanRoomAccessRestricted]' = None, comment: 'Optional[str]' = None, created_at: 'Optional[int]' = None, local_collaborator_alias: 'Optional[str]' = None, name: 'Optional[str]' = None, output_catalog: 'Optional[CleanRoomOutputCatalog]' = None, owner: 'Optional[str]' = None, remote_detailed_info: 'Optional[CleanRoomRemoteDetail]' = None, status: 'Optional[CleanRoomStatusEnum]' = None, updated_at: 'Optional[int]' = None)

access_restricted: CleanRoomAccessRestricted | None = None

Whether clean room access is restricted due to [CSP]

[CSP]: https://docs.databricks.com/en/security/privacy/security-profile.html

comment: str | None = None

created_at: int | None = None

When the clean room was created, in epoch milliseconds.

local_collaborator_alias: str | None = None

The alias of the collaborator tied to the local clean room.

name: str | None = None

The name of the clean room. It should follow [UC securable naming requirements].

[UC securable naming requirements]: https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements

output_catalog: CleanRoomOutputCatalog | None = None

Output catalog of the clean room. It is an output only field. Output catalog is manipulated using the separate CreateCleanRoomOutputCatalog API.

owner: str | None = None

This is the Databricks username of the owner of the local clean room securable for permission management.

remote_detailed_info: CleanRoomRemoteDetail | None = None

Central clean room details. During creation, users need to specify cloud_vendor, region, and collaborators.global_metastore_id. This field will not be filled in the ListCleanRooms call.

status: CleanRoomStatusEnum | None = None

Clean room status.

updated_at: int | None = None

When the clean room was last updated, in epoch milliseconds.

as_dict() → dict

Serializes the CleanRoom into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoom into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoom

Deserializes the CleanRoom from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAccessRestricted

CSP_MISMATCH = "CSP_MISMATCH"

NO_RESTRICTION = "NO_RESTRICTION"

class databricks.sdk.service.cleanrooms.CleanRoomAsset(name: str, asset_type: CleanRoomAssetAssetType, added_at: int | None = None, clean_room_name: str | None = None, foreign_table: CleanRoomAssetForeignTable | None = None, foreign_table_local_details: CleanRoomAssetForeignTableLocalDetails | None = None, notebook: CleanRoomAssetNotebook | None = None, owner_collaborator_alias: str | None = None, status: CleanRoomAssetStatusEnum | None = None, table: CleanRoomAssetTable | None = None, table_local_details: CleanRoomAssetTableLocalDetails | None = None, view: CleanRoomAssetView | None = None, view_local_details: CleanRoomAssetViewLocalDetails | None = None, volume_local_details: CleanRoomAssetVolumeLocalDetails | None = None)

Metadata of the clean room 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. For jar analyses, the name is the jar analysis name.

asset_type: CleanRoomAssetAssetType

The type of the asset.

added_at: int | None = None

When the asset is added to the clean room, in epoch milliseconds.

clean_room_name: str | None = None

The name of the clean room this asset belongs to. This field is required for create operations and populated by the server for responses.

foreign_table: CleanRoomAssetForeignTable | None = None

Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE

foreign_table_local_details: CleanRoomAssetForeignTableLocalDetails | None = None

Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE

notebook: CleanRoomAssetNotebook | None = None

Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE

owner_collaborator_alias: str | None = None

The alias of the collaborator who owns this asset

status: CleanRoomAssetStatusEnum | None = None

Status of the asset

table: CleanRoomAssetTable | None = None

Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE

table_local_details: CleanRoomAssetTableLocalDetails | None = None

Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE

view: CleanRoomAssetView | None = None

View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW

view_local_details: CleanRoomAssetViewLocalDetails | None = None

Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW

volume_local_details: CleanRoomAssetVolumeLocalDetails | None = None

Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME

as_dict() → dict

Serializes the CleanRoomAsset into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAsset into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAsset

Deserializes the CleanRoomAsset from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetAssetType

FOREIGN_TABLE = "FOREIGN_TABLE"

NOTEBOOK_FILE = "NOTEBOOK_FILE"

TABLE = "TABLE"

VIEW = "VIEW"

VOLUME = "VOLUME"

class databricks.sdk.service.cleanrooms.CleanRoomAssetForeignTable(columns: 'Optional[List[catalog.ColumnInfo]]' = None)

columns: List[ColumnInfo] | None = None

The metadata information of the columns in the foreign table

as_dict() → dict

Serializes the CleanRoomAssetForeignTable into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetForeignTable into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetForeignTable

Deserializes the CleanRoomAssetForeignTable from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetForeignTableLocalDetails(local_name: 'str')

local_name: str

The fully qualified name of the foreign table in its owner’s local metastore, in the format of catalog.*schema*.*foreign_table_name*

as_dict() → dict

Serializes the CleanRoomAssetForeignTableLocalDetails into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetForeignTableLocalDetails into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetForeignTableLocalDetails

Deserializes the CleanRoomAssetForeignTableLocalDetails from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetNotebook(notebook_content: 'str', etag: 'Optional[str]' = None, review_state: 'Optional[CleanRoomNotebookReviewNotebookReviewState]' = None, reviews: 'Optional[List[CleanRoomNotebookReview]]' = None, runner_collaborator_aliases: 'Optional[List[str]]' = None)

notebook_content: str

Base 64 representation of the notebook contents. This is the same format as returned by :method:workspace/export with the format of HTML.

etag: str | None = None

Server generated etag that represents the notebook version.

review_state: CleanRoomNotebookReviewNotebookReviewState | None = None

Top-level status derived from all reviews

reviews: List[CleanRoomNotebookReview] | None = None

All existing approvals or rejections

runner_collaborator_aliases: List[str] | None = None

Aliases of collaborators that can run the notebook.

as_dict() → dict

Serializes the CleanRoomAssetNotebook into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetNotebook into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetNotebook

Deserializes the CleanRoomAssetNotebook from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetStatusEnum

ACTIVE = "ACTIVE"

PENDING = "PENDING"

PERMISSION_DENIED = "PERMISSION_DENIED"

class databricks.sdk.service.cleanrooms.CleanRoomAssetTable(columns: 'Optional[List[catalog.ColumnInfo]]' = None)

columns: List[ColumnInfo] | None = None

The metadata information of the columns in the table

as_dict() → dict

Serializes the CleanRoomAssetTable into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetTable into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetTable

Deserializes the CleanRoomAssetTable from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetTableLocalDetails(local_name: 'str', partitions: 'Optional[List[sharing.Partition]]' = None)

local_name: str

The fully qualified name of the table in its owner’s local metastore, in the format of catalog.*schema*.*table_name*

partitions: List[Partition] | None = None

Partition filtering specification for a shared table.

as_dict() → dict

Serializes the CleanRoomAssetTableLocalDetails into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetTableLocalDetails into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetTableLocalDetails

Deserializes the CleanRoomAssetTableLocalDetails from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetView(columns: 'Optional[List[catalog.ColumnInfo]]' = None)

columns: List[ColumnInfo] | None = None

The metadata information of the columns in the view

as_dict() → dict

Serializes the CleanRoomAssetView into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetView into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetView

Deserializes the CleanRoomAssetView from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetViewLocalDetails(local_name: 'str')

local_name: str

The fully qualified name of the view in its owner’s local metastore, in the format of catalog.*schema*.*view_name*

as_dict() → dict

Serializes the CleanRoomAssetViewLocalDetails into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetViewLocalDetails into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetViewLocalDetails

Deserializes the CleanRoomAssetViewLocalDetails from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAssetVolumeLocalDetails(local_name: 'str')

local_name: str

The fully qualified name of the volume in its owner’s local metastore, in the format of catalog.*schema*.*volume_name*

as_dict() → dict

Serializes the CleanRoomAssetVolumeLocalDetails into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAssetVolumeLocalDetails into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAssetVolumeLocalDetails

Deserializes the CleanRoomAssetVolumeLocalDetails from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAutoApprovalRule(author_collaborator_alias: 'Optional[str]' = None, author_scope: 'Optional[CleanRoomAutoApprovalRuleAuthorScope]' = None, clean_room_name: 'Optional[str]' = None, created_at: 'Optional[int]' = None, rule_id: 'Optional[str]' = None, rule_owner_collaborator_alias: 'Optional[str]' = None, runner_collaborator_alias: 'Optional[str]' = None)

author_collaborator_alias: str | None = None

Collaborator alias of the author covered by the rule. Only one of author_collaborator_alias and author_scope can be set.

author_scope: CleanRoomAutoApprovalRuleAuthorScope | None = None

Scope of authors covered by the rule. Only one of author_collaborator_alias and author_scope can be set.

clean_room_name: str | None = None

The name of the clean room this auto-approval rule belongs to.

created_at: int | None = None

Timestamp of when the rule was created, in epoch milliseconds.

rule_id: str | None = None

A generated UUID identifying the rule.

rule_owner_collaborator_alias: str | None = None

The owner of the rule to whom the rule applies.

runner_collaborator_alias: str | None = None

Collaborator alias of the runner covered by the rule.

as_dict() → dict

Serializes the CleanRoomAutoApprovalRule into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomAutoApprovalRule into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomAutoApprovalRule

Deserializes the CleanRoomAutoApprovalRule from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomAutoApprovalRuleAuthorScope

ANY_AUTHOR = "ANY_AUTHOR"

class databricks.sdk.service.cleanrooms.CleanRoomCollaborator(collaborator_alias: str, display_name: str | None = None, global_metastore_id: str | None = None, invite_recipient_email: str | None = None, invite_recipient_workspace_id: int | None = None, organization_name: str | None = None)

Publicly visible clean room collaborator.

collaborator_alias: str

Collaborator alias specified by the clean room creator. It is unique across all collaborators of this clean room, and used to derive multiple values internally such as catalog alias and clean room name for single metastore clean rooms. It should follow [UC securable naming requirements].

[UC securable naming requirements]: https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements

display_name: str | None = None

Generated display name for the collaborator. In the case of a single metastore clean room, it is the clean room name. For x-metastore clean rooms, it is the organization name of the metastore. It is not restricted to these values and could change in the future

global_metastore_id: str | None = None

The global Unity Catalog metastore ID of the collaborator. The identifier is of format cloud:region:metastore-uuid.

invite_recipient_email: str | None = None

Email of the user who is receiving the clean room “invitation”. It should be empty for the creator of the clean room, and non-empty for the invitees of the clean room. It is only returned in the output when clean room creator calls GET

invite_recipient_workspace_id: int | None = None

Workspace ID of the user who is receiving the clean room “invitation”. Must be specified if invite_recipient_email is specified. It should be empty when the collaborator is the creator of the clean room.

organization_name: str | None = None

[Organization name](:method:metastores/list#metastores-delta_sharing_organization_name) configured in the metastore

as_dict() → dict

Serializes the CleanRoomCollaborator into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomCollaborator into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomCollaborator

Deserializes the CleanRoomCollaborator from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomNotebookReview(comment: 'Optional[str]' = None, created_at_millis: 'Optional[int]' = None, review_state: 'Optional[CleanRoomNotebookReviewNotebookReviewState]' = None, review_sub_reason: 'Optional[CleanRoomNotebookReviewNotebookReviewSubReason]' = None, reviewer_collaborator_alias: 'Optional[str]' = None)

comment: str | None = None

Review comment

created_at_millis: int | None = None

When the review was submitted, in epoch milliseconds

review_state: CleanRoomNotebookReviewNotebookReviewState | None = None

Review outcome

review_sub_reason: CleanRoomNotebookReviewNotebookReviewSubReason | None = None

Specified when the review was not explicitly made by a user

reviewer_collaborator_alias: str | None = None

Collaborator alias of the reviewer

as_dict() → dict

Serializes the CleanRoomNotebookReview into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomNotebookReview into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomNotebookReview

Deserializes the CleanRoomNotebookReview from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomNotebookReviewNotebookReviewState

APPROVED = "APPROVED"

PENDING = "PENDING"

REJECTED = "REJECTED"

class databricks.sdk.service.cleanrooms.CleanRoomNotebookReviewNotebookReviewSubReason

AUTO_APPROVED = "AUTO_APPROVED"

BACKFILLED = "BACKFILLED"

class databricks.sdk.service.cleanrooms.CleanRoomNotebookTaskRun(collaborator_job_run_info: CollaboratorJobRunInfo | None = None, notebook_etag: str | None = None, notebook_job_run_state: CleanRoomTaskRunState | None = None, notebook_name: str | None = None, notebook_updated_at: int | None = None, output_schema_expiration_time: int | None = None, output_schema_name: str | None = None, run_duration: int | None = None, start_time: int | None = None)

Stores information about a single task run.

collaborator_job_run_info: CollaboratorJobRunInfo | None = None

Job run info of the task in the runner’s local workspace. This field is only included in the LIST API. if the task was run within the same workspace the API is being called. If the task run was in a different workspace under the same metastore, only the workspace_id is included.

notebook_etag: str | None = None

Etag of the notebook executed in this task run, used to identify the notebook version.

notebook_job_run_state: CleanRoomTaskRunState | None = None

State of the task run.

notebook_name: str | None = None

Asset name of the notebook executed in this task run.

notebook_updated_at: int | None = None

The timestamp of when the notebook was last updated.

output_schema_expiration_time: int | None = None

Expiration time of the output schema of the task run (if any), in epoch milliseconds.

output_schema_name: str | None = None

Name of the output schema associated with the clean rooms notebook task run.

run_duration: int | None = None

Duration of the task run, in milliseconds.

start_time: int | None = None

When the task run started, in epoch milliseconds.

as_dict() → dict

Serializes the CleanRoomNotebookTaskRun into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomNotebookTaskRun into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomNotebookTaskRun

Deserializes the CleanRoomNotebookTaskRun from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomOutputCatalog(catalog_name: 'Optional[str]' = None, status: 'Optional[CleanRoomOutputCatalogOutputCatalogStatus]' = None)

catalog_name: str | None = None

The name of the output catalog in UC. It should follow [UC securable naming requirements]. The field will always exist if status is CREATED.

[UC securable naming requirements]: https://docs.databricks.com/en/data-governance/unity-catalog/index.html#securable-object-naming-requirements

status: CleanRoomOutputCatalogOutputCatalogStatus | None = None

as_dict() → dict

Serializes the CleanRoomOutputCatalog into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomOutputCatalog into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomOutputCatalog

Deserializes the CleanRoomOutputCatalog from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomOutputCatalogOutputCatalogStatus

CREATED = "CREATED"

NOT_CREATED = "NOT_CREATED"

NOT_ELIGIBLE = "NOT_ELIGIBLE"

class databricks.sdk.service.cleanrooms.CleanRoomRemoteDetail(central_clean_room_id: str | None = None, cloud_vendor: str | None = None, collaborators: List[CleanRoomCollaborator] | None = None, compliance_security_profile: ComplianceSecurityProfile | None = None, creator: CleanRoomCollaborator | None = None, egress_network_policy: EgressNetworkPolicy | None = None, region: str | None = None)

Publicly visible central clean room details.

central_clean_room_id: str | None = None

Central clean room ID.

cloud_vendor: str | None = None

Cloud vendor (aws,azure,gcp) of the central clean room.

collaborators: List[CleanRoomCollaborator] | None = None

Collaborators in the central clean room. There should one and only one collaborator in the list that satisfies the owner condition:

1. It has the creator’s global_metastore_id (determined by caller of CreateCleanRoom).

2. Its invite_recipient_email is empty.

compliance_security_profile: ComplianceSecurityProfile | None = None

creator: CleanRoomCollaborator | None = None

Collaborator who creates the clean room.

egress_network_policy: EgressNetworkPolicy | None = None

Egress network policy to apply to the central clean room workspace.

region: str | None = None

Region of the central clean room.

as_dict() → dict

Serializes the CleanRoomRemoteDetail into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CleanRoomRemoteDetail into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CleanRoomRemoteDetail

Deserializes the CleanRoomRemoteDetail from a dictionary.

class databricks.sdk.service.cleanrooms.CleanRoomStatusEnum

ACTIVE = "ACTIVE"

DELETED = "DELETED"

FAILED = "FAILED"

PROVISIONING = "PROVISIONING"

class databricks.sdk.service.cleanrooms.CollaboratorJobRunInfo(collaborator_alias: 'Optional[str]' = None, collaborator_job_id: 'Optional[int]' = None, collaborator_job_run_id: 'Optional[int]' = None, collaborator_task_run_id: 'Optional[int]' = None, collaborator_workspace_id: 'Optional[int]' = None)

collaborator_alias: str | None = None

Alias of the collaborator that triggered the task run.

collaborator_job_id: int | None = None

Job ID of the task run in the collaborator’s workspace.

collaborator_job_run_id: int | None = None

Job run ID of the task run in the collaborator’s workspace.

collaborator_task_run_id: int | None = None

Task run ID of the task run in the collaborator’s workspace.

collaborator_workspace_id: int | None = None

ID of the collaborator’s workspace that triggered the task run.

as_dict() → dict

Serializes the CollaboratorJobRunInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CollaboratorJobRunInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CollaboratorJobRunInfo

Deserializes the CollaboratorJobRunInfo from a dictionary.

class databricks.sdk.service.cleanrooms.ComplianceSecurityProfile(compliance_standards: List[ComplianceStandard] | None = None, is_enabled: bool | None = None)

The compliance security profile used to process regulated data following compliance standards.

compliance_standards: List[ComplianceStandard] | None = None

The list of compliance standards that the compliance security profile is configured to enforce.

is_enabled: bool | None = None

Whether the compliance security profile is enabled.

as_dict() → dict

Serializes the ComplianceSecurityProfile into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ComplianceSecurityProfile into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ComplianceSecurityProfile

Deserializes the ComplianceSecurityProfile from a dictionary.

class databricks.sdk.service.cleanrooms.CreateCleanRoomAssetReviewResponse(notebook_review_state: 'Optional[CleanRoomNotebookReviewNotebookReviewState]' = None, notebook_reviews: 'Optional[List[CleanRoomNotebookReview]]' = None)

notebook_review_state: CleanRoomNotebookReviewNotebookReviewState | None = None

Top-level status derived from all reviews

notebook_reviews: List[CleanRoomNotebookReview] | None = None

All existing notebook approvals or rejections

as_dict() → dict

Serializes the CreateCleanRoomAssetReviewResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CreateCleanRoomAssetReviewResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CreateCleanRoomAssetReviewResponse

Deserializes the CreateCleanRoomAssetReviewResponse from a dictionary.

class databricks.sdk.service.cleanrooms.CreateCleanRoomOutputCatalogResponse(output_catalog: 'CleanRoomOutputCatalog')

output_catalog: CleanRoomOutputCatalog

as_dict() → dict

Serializes the CreateCleanRoomOutputCatalogResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the CreateCleanRoomOutputCatalogResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → CreateCleanRoomOutputCatalogResponse

Deserializes the CreateCleanRoomOutputCatalogResponse from a dictionary.

class databricks.sdk.service.cleanrooms.DeleteCleanRoomAssetResponse

Response for delete clean room request. Using an empty message since the generic Empty proto does not externd UnshadedMessageMarker.

as_dict() → dict

Serializes the DeleteCleanRoomAssetResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the DeleteCleanRoomAssetResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → DeleteCleanRoomAssetResponse

Deserializes the DeleteCleanRoomAssetResponse from a dictionary.

class databricks.sdk.service.cleanrooms.ListCleanRoomAssetRevisionsResponse(next_page_token: 'Optional[str]' = None, revisions: 'Optional[List[CleanRoomAsset]]' = None)

next_page_token: str | None = None

revisions: List[CleanRoomAsset] | None = None

as_dict() → dict

Serializes the ListCleanRoomAssetRevisionsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListCleanRoomAssetRevisionsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListCleanRoomAssetRevisionsResponse

Deserializes the ListCleanRoomAssetRevisionsResponse from a dictionary.

class databricks.sdk.service.cleanrooms.ListCleanRoomAssetsResponse(assets: 'Optional[List[CleanRoomAsset]]' = None, next_page_token: 'Optional[str]' = None)

assets: List[CleanRoomAsset] | None = None

Assets in the clean room.

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. page_token should be set to this value for the next request (for the next page of results).

as_dict() → dict

Serializes the ListCleanRoomAssetsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListCleanRoomAssetsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListCleanRoomAssetsResponse

Deserializes the ListCleanRoomAssetsResponse from a dictionary.

class databricks.sdk.service.cleanrooms.ListCleanRoomAutoApprovalRulesResponse(next_page_token: 'Optional[str]' = None, rules: 'Optional[List[CleanRoomAutoApprovalRule]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. page_token should be set to this value for the next request (for the next page of results).

rules: List[CleanRoomAutoApprovalRule] | None = None

as_dict() → dict

Serializes the ListCleanRoomAutoApprovalRulesResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListCleanRoomAutoApprovalRulesResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListCleanRoomAutoApprovalRulesResponse

Deserializes the ListCleanRoomAutoApprovalRulesResponse from a dictionary.

class databricks.sdk.service.cleanrooms.ListCleanRoomNotebookTaskRunsResponse(next_page_token: 'Optional[str]' = None, runs: 'Optional[List[CleanRoomNotebookTaskRun]]' = None)

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. page_token should be set to this value for the next request (for the next page of results).

runs: List[CleanRoomNotebookTaskRun] | None = None

Name of the clean room.

as_dict() → dict

Serializes the ListCleanRoomNotebookTaskRunsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListCleanRoomNotebookTaskRunsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListCleanRoomNotebookTaskRunsResponse

Deserializes the ListCleanRoomNotebookTaskRunsResponse from a dictionary.

class databricks.sdk.service.cleanrooms.ListCleanRoomsResponse(clean_rooms: 'Optional[List[CleanRoom]]' = None, next_page_token: 'Optional[str]' = None)

clean_rooms: List[CleanRoom] | None = None

next_page_token: str | None = None

Opaque token to retrieve the next page of results. Absent if there are no more pages. page_token should be set to this value for the next request (for the next page of results).

as_dict() → dict

Serializes the ListCleanRoomsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListCleanRoomsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListCleanRoomsResponse

Deserializes the ListCleanRoomsResponse from a dictionary.

class databricks.sdk.service.cleanrooms.NotebookVersionReview(etag: 'str', review_state: 'CleanRoomNotebookReviewNotebookReviewState', comment: 'Optional[str]' = None)

etag: str

Etag identifying the notebook version

review_state: CleanRoomNotebookReviewNotebookReviewState

Review outcome

comment: str | None = None

Review comment

as_dict() → dict

Serializes the NotebookVersionReview into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the NotebookVersionReview into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → NotebookVersionReview

Deserializes the NotebookVersionReview from a dictionary.