Interface CleanRoomAsset

Metadata of the clean room asset

interface CleanRoomAsset {
    addedAt?: bigint;
    assetType?: CleanRoomAsset_AssetType;
    cleanRoomName?: string;
    details?:
        | { $case: "table"; table: CleanRoomAsset_Table }
        | { $case: "notebook"; notebook: CleanRoomAsset_Notebook }
        | { $case: "view"; view: CleanRoomAsset_View }
        | { $case: "foreignTable"; foreignTable: CleanRoomAsset_ForeignTable };
    localDetails?:
        | {
            $case: "tableLocalDetails";
            tableLocalDetails: CleanRoomAsset_TableLocalDetails;
        }
        | {
            $case: "volumeLocalDetails";
            volumeLocalDetails: CleanRoomAsset_VolumeLocalDetails;
        }
        | {
            $case: "viewLocalDetails";
            viewLocalDetails: CleanRoomAsset_ViewLocalDetails;
        }
        | {
            $case: "foreignTableLocalDetails";
            foreignTableLocalDetails: CleanRoomAsset_ForeignTableLocalDetails;
        };
    name?: string;
    ownerCollaboratorAlias?: string;
    status?: CleanRoomAsset_Status_Enum;
}

Index

Properties

addedAt? assetType? cleanRoomName? details? localDetails? name? ownerCollaboratorAlias? status?

Properties

`Optional`addedAt

addedAt?: bigint

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

`Optional`assetType

assetType?: CleanRoomAsset_AssetType

The type of the asset.

`Optional`cleanRoomName

cleanRoomName?: string

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

`Optional`details

details?:
    | { $case: "table"; table: CleanRoomAsset_Table }
    | { $case: "notebook"; notebook: CleanRoomAsset_Notebook }
    | { $case: "view"; view: CleanRoomAsset_View }
    | { $case: "foreignTable"; foreignTable: CleanRoomAsset_ForeignTable }

the asset-type specific information. Will not be returned by list

Type Declaration

{ $case: "table"; table: CleanRoomAsset_Table }
- $case: "table"
- table: CleanRoomAsset_Table
  Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
{ $case: "notebook"; notebook: CleanRoomAsset_Notebook }
- $case: "notebook"
- notebook: CleanRoomAsset_Notebook
  Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
{ $case: "view"; view: CleanRoomAsset_View }
- $case: "view"
- view: CleanRoomAsset_View
  View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
{ $case: "foreignTable"; foreignTable: CleanRoomAsset_ForeignTable }
- $case: "foreignTable"
- foreignTable: CleanRoomAsset_ForeignTable
  Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE

`Optional`localDetails

localDetails?:
    | {
        $case: "tableLocalDetails";
        tableLocalDetails: CleanRoomAsset_TableLocalDetails;
    }
    | {
        $case: "volumeLocalDetails";
        volumeLocalDetails: CleanRoomAsset_VolumeLocalDetails;
    }
    | {
        $case: "viewLocalDetails";
        viewLocalDetails: CleanRoomAsset_ViewLocalDetails;
    }
    | {
        $case: "foreignTableLocalDetails";
        foreignTableLocalDetails: CleanRoomAsset_ForeignTableLocalDetails;
    }

asset-type specific local information of the asset

Type Declaration

{
$case: "tableLocalDetails";
tableLocalDetails: CleanRoomAsset_TableLocalDetails;
}
- $case: "tableLocalDetails"
- tableLocalDetails: CleanRoomAsset_TableLocalDetails
  Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
{
$case: "volumeLocalDetails";
volumeLocalDetails: CleanRoomAsset_VolumeLocalDetails;
}
- $case: "volumeLocalDetails"
- volumeLocalDetails: CleanRoomAsset_VolumeLocalDetails
  Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
{ $case: "viewLocalDetails"; viewLocalDetails: CleanRoomAsset_ViewLocalDetails }
- $case: "viewLocalDetails"
- viewLocalDetails: CleanRoomAsset_ViewLocalDetails
  Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
{
$case: "foreignTableLocalDetails";
foreignTableLocalDetails: CleanRoomAsset_ForeignTableLocalDetails;
}
- $case: "foreignTableLocalDetails"
- foreignTableLocalDetails: CleanRoomAsset_ForeignTableLocalDetails
  Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE

`Optional`name

name?: string

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.

`Optional`ownerCollaboratorAlias

ownerCollaboratorAlias?: string

The alias of the collaborator who owns this asset

`Optional`status

status?: CleanRoomAsset_Status_Enum

Status of the asset

Interface CleanRoomAsset

Index

Properties

Properties

`Optional`addedAt

`Optional`assetType

`Optional`cleanRoomName

`Optional`details

Type Declaration

$case: "table"

table: CleanRoomAsset_Table

$case: "notebook"

notebook: CleanRoomAsset_Notebook

$case: "view"

view: CleanRoomAsset_View

$case: "foreignTable"

foreignTable: CleanRoomAsset_ForeignTable

`Optional`localDetails

Type Declaration

$case: "tableLocalDetails"

tableLocalDetails: CleanRoomAsset_TableLocalDetails

$case: "volumeLocalDetails"

volumeLocalDetails: CleanRoomAsset_VolumeLocalDetails

$case: "viewLocalDetails"

viewLocalDetails: CleanRoomAsset_ViewLocalDetails

$case: "foreignTableLocalDetails"

foreignTableLocalDetails: CleanRoomAsset_ForeignTableLocalDetails

`Optional`name

`Optional`ownerCollaboratorAlias

`Optional`status

Settings

On This Page

Interface CleanRoomAsset

Index

Properties

Properties

OptionaladdedAt

OptionalassetType

OptionalcleanRoomName

Optionaldetails

Type Declaration

$case: "table"

table: CleanRoomAsset_Table

$case: "notebook"

notebook: CleanRoomAsset_Notebook

$case: "view"

view: CleanRoomAsset_View

$case: "foreignTable"

foreignTable: CleanRoomAsset_ForeignTable

OptionallocalDetails

Type Declaration

$case: "tableLocalDetails"

tableLocalDetails: CleanRoomAsset_TableLocalDetails

$case: "volumeLocalDetails"

volumeLocalDetails: CleanRoomAsset_VolumeLocalDetails

$case: "viewLocalDetails"

viewLocalDetails: CleanRoomAsset_ViewLocalDetails

$case: "foreignTableLocalDetails"

foreignTableLocalDetails: CleanRoomAsset_ForeignTableLocalDetails

Optionalname

OptionalownerCollaboratorAlias

Optionalstatus

Settings

On This Page

`Optional`addedAt

`Optional`assetType

`Optional`cleanRoomName

`Optional`details

`Optional`localDetails

`Optional`name

`Optional`ownerCollaboratorAlias

`Optional`status