Asset

View as Markdown

Metadata of the clean room asset

Get an assetGET /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}List assetsGET /api/2.0/clean-rooms/{clean_room_name}/assetsCreate an assetPOST /api/2.0/clean-rooms/{clean_room_name}/assetsUpdate an assetPATCH /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}Delete an assetDELETE /api/2.0/clean-rooms/{clean_room_name}/assets/{asset_type}/{name}

CleanRoomAsset object

Metadata of the clean room asset

clean_room_namestring

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

Example: test-clean-room1

namestring

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. For Genie spaces, the name is derived from the clean room; the caller does not choose it.

Example: creator.sales.products

asset_typestring

The type of the asset.

Values:

• ASSET_TYPE_UNSPECIFIED
• TABLE
• NOTEBOOK_FILE
• VOLUME
• VIEW
• FOREIGN_TABLE
• JAR_ANALYSIS Public Preview

added_atint64Output only

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

Example: 1716424663321

statusstringOutput only

Status of the asset

Values:

• ENUM_UNSPECIFIED
• ACTIVE
• PERMISSION_DENIED
• PENDING

owner_collaborator_aliasstringOutput only

The alias of the collaborator who owns this asset

Example: creator

table_local_detailsobject

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

Show child attributesHide child attributes

local_namestring

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

Example: demo.sales.products

partitionsarray of object

Partition filtering specification for a shared table.

Show child attributesHide child attributes

valuesarray of object

An array of partition values.

Show child attributesHide child attributes

namestring

The name of the partition column.

valuestring

The value of the partition column. When this value is not set, it means null value. When this field is set, field recipient_property_key can not be set.

recipient_property_keystring

The key of a Delta Sharing recipient's property. For example "databricks-account-id". When this field is set, field value can not be set.

opstring

The operator to apply for the value.

Values:

• EQUAL
• LIKE

volume_local_detailsobject

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

Show child attributesHide child attributes

local_namestring

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

Example: demo.sales.products

view_local_detailsobject

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

Show child attributesHide child attributes

local_namestring

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

Example: demo.sales.products

foreign_table_local_detailsobject

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

Show child attributesHide child attributes

local_namestring

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

Example: demo.sales.products

tableobject

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

Show child attributesHide child attributes

columnsarray of objectOutput only

The metadata information of the columns in the table

Show child attributesHide child attributes

namestring

Name of Column.

type_textstring

Full data type specification as SQL/catalogString text.

type_namestring

Values:

Show 24 possible values

• BOOLEAN
• BYTE
• SHORT
• INT
• LONG
• FLOAT
• DOUBLE
• DATE
• TIMESTAMP
• STRING
• BINARY
• DECIMAL
• INTERVAL
• ARRAY
• STRUCT
• MAP
• CHAR
• NULL
• USER_DEFINED_TYPE
• TIMESTAMP_NTZ
• VARIANT
• GEOMETRY
• GEOGRAPHY
• TABLE_TYPE

positionint32

Ordinal position of column (starting at position 0).

type_precisionint32

Digits of precision; required for DecimalTypes.

type_scaleint32

Digits to right of decimal; Required for DecimalTypes.

type_interval_typestring

Format of IntervalType.

type_jsonstring

Full data type specification, JSON-serialized.

commentstring

User-provided free-form text description.

nullableboolean

Whether field may be Null (default: true).

Default: true

partition_indexint32

Partition index for column.

maskobject

Show child attributesHide child attributes

function_namestring

The full name of the column mask SQL UDF.

using_column_namesarray of string

The list of additional table columns to be passed as input to the column mask function. The first arg of the mask function should be of the type of the column being masked and the types of the rest of the args should match the types of columns in 'using_column_names'.

using_argumentsarray of objectDeprecated

The list of table columns or literals to be passed as additional arguments to a column mask function, carrying the type (column reference vs constant literal) of each argument. Deprecated: use using_column_names instead.

Show child attributesHide child attributes

columnstring

A column reference.

constantstring

A constant literal.

notebookobject

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

Show child attributesHide child attributes

notebook_contentstring

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

etagstringOutput only

Server generated etag that represents the notebook version.

runner_collaborator_aliasesarray of string

Aliases of collaborators that can run the notebook.

reviewsarray of objectOutput only

All existing approvals or rejections

Show child attributesHide child attributes

reviewer_collaborator_aliasstring

Collaborator alias of the reviewer

created_at_millisint64

When the review was submitted, in epoch milliseconds

review_statestring

Review outcome

Values:

• NOTEBOOK_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

commentstring<= 500 characters

Review comment

Example: Code looks wrong

review_sub_reasonstring

Specified when the review was not explicitly made by a user

Values:

• NOTEBOOK_REVIEW_SUB_REASON_UNSPECIFIED
• BACKFILLED
• AUTO_APPROVED

review_statestringOutput only

Top-level status derived from all reviews

Values:

• NOTEBOOK_REVIEW_STATE_UNSPECIFIED
• APPROVED
• REJECTED
• PENDING

descriptionstring<= 10000 characters

Optional description of the notebook shown to all collaborators.

Example: This is a description of the Clean Room Notebook

environment_versionstring

The serverless environment version used to execute the notebook (e.g. "4"). Defaults to "2" if not specified.

viewobject

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

Show child attributesHide child attributes

columnsarray of objectOutput only

The metadata information of the columns in the view

Show child attributesHide child attributes

namestring

Name of Column.

type_textstring

Full data type specification as SQL/catalogString text.

type_namestring

Values:

Show 24 possible values

• BOOLEAN
• BYTE
• SHORT
• INT
• LONG
• FLOAT
• DOUBLE
• DATE
• TIMESTAMP
• STRING
• BINARY
• DECIMAL
• INTERVAL
• ARRAY
• STRUCT
• MAP
• CHAR
• NULL
• USER_DEFINED_TYPE
• TIMESTAMP_NTZ
• VARIANT
• GEOMETRY
• GEOGRAPHY
• TABLE_TYPE