databricks.CleanRoomAsset
Explore with Pulumi AI
Clean room assets are data and code objects – tables, volumes, and notebooks that are shared with the clean room.
Example Usage
Example: Clean Room Asset Resource
Example for sharing a table
This is an example for sharing an asset (table) in a clean room:
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
const _this = new databricks.index.CleanRoomsAsset("this", {
cleanRoomName: "existing_clean_room",
name: "creator.default.myasset",
assetType: "TABLE",
tableLocalDetails: {
localName: "some_creator.default.myasset",
},
});
import pulumi
import pulumi_databricks as databricks
this = databricks.index.CleanRoomsAsset("this",
clean_room_name=existing_clean_room,
name=creator.default.myasset,
asset_type=TABLE,
table_local_details={
localName: some_creator.default.myasset,
})
package main
import (
"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databricks.NewCleanRoomsAsset(ctx, "this", &databricks.CleanRoomsAssetArgs{
CleanRoomName: "existing_clean_room",
Name: "creator.default.myasset",
AssetType: "TABLE",
TableLocalDetails: map[string]interface{}{
"localName": "some_creator.default.myasset",
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
return await Deployment.RunAsync(() =>
{
var @this = new Databricks.Index.CleanRoomsAsset("this", new()
{
CleanRoomName = "existing_clean_room",
Name = "creator.default.myasset",
AssetType = "TABLE",
TableLocalDetails =
{
{ "localName", "some_creator.default.myasset" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.cleanRoomsAsset;
import com.pulumi.databricks.cleanRoomsAssetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var this_ = new CleanRoomsAsset("this", CleanRoomsAssetArgs.builder()
.cleanRoomName("existing_clean_room")
.name("creator.default.myasset")
.assetType("TABLE")
.tableLocalDetails(Map.of("localName", "some_creator.default.myasset"))
.build());
}
}
resources:
this:
type: databricks:cleanRoomsAsset
properties:
cleanRoomName: existing_clean_room
name: creator.default.myasset
assetType: TABLE
tableLocalDetails:
localName: some_creator.default.myasset
Create CleanRoomAsset Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CleanRoomAsset(name: string, args: CleanRoomAssetArgs, opts?: CustomResourceOptions);
@overload
def CleanRoomAsset(resource_name: str,
args: CleanRoomAssetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CleanRoomAsset(resource_name: str,
opts: Optional[ResourceOptions] = None,
asset_type: Optional[str] = None,
clean_room_name: Optional[str] = None,
foreign_table: Optional[CleanRoomAssetForeignTableArgs] = None,
foreign_table_local_details: Optional[CleanRoomAssetForeignTableLocalDetailsArgs] = None,
name: Optional[str] = None,
notebook: Optional[CleanRoomAssetNotebookArgs] = None,
table: Optional[CleanRoomAssetTableArgs] = None,
table_local_details: Optional[CleanRoomAssetTableLocalDetailsArgs] = None,
view: Optional[CleanRoomAssetViewArgs] = None,
view_local_details: Optional[CleanRoomAssetViewLocalDetailsArgs] = None,
volume_local_details: Optional[CleanRoomAssetVolumeLocalDetailsArgs] = None)
func NewCleanRoomAsset(ctx *Context, name string, args CleanRoomAssetArgs, opts ...ResourceOption) (*CleanRoomAsset, error)
public CleanRoomAsset(string name, CleanRoomAssetArgs args, CustomResourceOptions? opts = null)
public CleanRoomAsset(String name, CleanRoomAssetArgs args)
public CleanRoomAsset(String name, CleanRoomAssetArgs args, CustomResourceOptions options)
type: databricks:CleanRoomAsset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CleanRoomAssetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CleanRoomAssetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CleanRoomAssetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CleanRoomAssetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CleanRoomAssetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var cleanRoomAssetResource = new Databricks.CleanRoomAsset("cleanRoomAssetResource", new()
{
AssetType = "string",
CleanRoomName = "string",
ForeignTable = new Databricks.Inputs.CleanRoomAssetForeignTableArgs
{
Columns = new[]
{
new Databricks.Inputs.CleanRoomAssetForeignTableColumnArgs
{
Comment = "string",
Mask = new Databricks.Inputs.CleanRoomAssetForeignTableColumnMaskArgs
{
FunctionName = "string",
UsingColumnNames = new[]
{
"string",
},
},
Name = "string",
Nullable = false,
PartitionIndex = 0,
Position = 0,
TypeIntervalType = "string",
TypeJson = "string",
TypeName = "string",
TypePrecision = 0,
TypeScale = 0,
TypeText = "string",
},
},
},
ForeignTableLocalDetails = new Databricks.Inputs.CleanRoomAssetForeignTableLocalDetailsArgs
{
LocalName = "string",
},
Name = "string",
Notebook = new Databricks.Inputs.CleanRoomAssetNotebookArgs
{
NotebookContent = "string",
Etag = "string",
ReviewState = "string",
Reviews = new[]
{
new Databricks.Inputs.CleanRoomAssetNotebookReviewArgs
{
Comment = "string",
CreatedAtMillis = 0,
ReviewState = "string",
ReviewSubReason = "string",
ReviewerCollaboratorAlias = "string",
},
},
RunnerCollaboratorAliases = new[]
{
"string",
},
},
Table = new Databricks.Inputs.CleanRoomAssetTableArgs
{
Columns = new[]
{
new Databricks.Inputs.CleanRoomAssetTableColumnArgs
{
Comment = "string",
Mask = new Databricks.Inputs.CleanRoomAssetTableColumnMaskArgs
{
FunctionName = "string",
UsingColumnNames = new[]
{
"string",
},
},
Name = "string",
Nullable = false,
PartitionIndex = 0,
Position = 0,
TypeIntervalType = "string",
TypeJson = "string",
TypeName = "string",
TypePrecision = 0,
TypeScale = 0,
TypeText = "string",
},
},
},
TableLocalDetails = new Databricks.Inputs.CleanRoomAssetTableLocalDetailsArgs
{
LocalName = "string",
Partitions = new[]
{
new Databricks.Inputs.CleanRoomAssetTableLocalDetailsPartitionArgs
{
Values = new[]
{
new Databricks.Inputs.CleanRoomAssetTableLocalDetailsPartitionValueArgs
{
Name = "string",
Op = "string",
RecipientPropertyKey = "string",
Value = "string",
},
},
},
},
},
View = new Databricks.Inputs.CleanRoomAssetViewArgs
{
Columns = new[]
{
new Databricks.Inputs.CleanRoomAssetViewColumnArgs
{
Comment = "string",
Mask = new Databricks.Inputs.CleanRoomAssetViewColumnMaskArgs
{
FunctionName = "string",
UsingColumnNames = new[]
{
"string",
},
},
Name = "string",
Nullable = false,
PartitionIndex = 0,
Position = 0,
TypeIntervalType = "string",
TypeJson = "string",
TypeName = "string",
TypePrecision = 0,
TypeScale = 0,
TypeText = "string",
},
},
},
ViewLocalDetails = new Databricks.Inputs.CleanRoomAssetViewLocalDetailsArgs
{
LocalName = "string",
},
VolumeLocalDetails = new Databricks.Inputs.CleanRoomAssetVolumeLocalDetailsArgs
{
LocalName = "string",
},
});
example, err := databricks.NewCleanRoomAsset(ctx, "cleanRoomAssetResource", &databricks.CleanRoomAssetArgs{
AssetType: pulumi.String("string"),
CleanRoomName: pulumi.String("string"),
ForeignTable: &databricks.CleanRoomAssetForeignTableArgs{
Columns: databricks.CleanRoomAssetForeignTableColumnArray{
&databricks.CleanRoomAssetForeignTableColumnArgs{
Comment: pulumi.String("string"),
Mask: &databricks.CleanRoomAssetForeignTableColumnMaskArgs{
FunctionName: pulumi.String("string"),
UsingColumnNames: pulumi.StringArray{
pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Nullable: pulumi.Bool(false),
PartitionIndex: pulumi.Int(0),
Position: pulumi.Int(0),
TypeIntervalType: pulumi.String("string"),
TypeJson: pulumi.String("string"),
TypeName: pulumi.String("string"),
TypePrecision: pulumi.Int(0),
TypeScale: pulumi.Int(0),
TypeText: pulumi.String("string"),
},
},
},
ForeignTableLocalDetails: &databricks.CleanRoomAssetForeignTableLocalDetailsArgs{
LocalName: pulumi.String("string"),
},
Name: pulumi.String("string"),
Notebook: &databricks.CleanRoomAssetNotebookArgs{
NotebookContent: pulumi.String("string"),
Etag: pulumi.String("string"),
ReviewState: pulumi.String("string"),
Reviews: databricks.CleanRoomAssetNotebookReviewArray{
&databricks.CleanRoomAssetNotebookReviewArgs{
Comment: pulumi.String("string"),
CreatedAtMillis: pulumi.Int(0),
ReviewState: pulumi.String("string"),
ReviewSubReason: pulumi.String("string"),
ReviewerCollaboratorAlias: pulumi.String("string"),
},
},
RunnerCollaboratorAliases: pulumi.StringArray{
pulumi.String("string"),
},
},
Table: &databricks.CleanRoomAssetTableArgs{
Columns: databricks.CleanRoomAssetTableColumnArray{
&databricks.CleanRoomAssetTableColumnArgs{
Comment: pulumi.String("string"),
Mask: &databricks.CleanRoomAssetTableColumnMaskArgs{
FunctionName: pulumi.String("string"),
UsingColumnNames: pulumi.StringArray{
pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Nullable: pulumi.Bool(false),
PartitionIndex: pulumi.Int(0),
Position: pulumi.Int(0),
TypeIntervalType: pulumi.String("string"),
TypeJson: pulumi.String("string"),
TypeName: pulumi.String("string"),
TypePrecision: pulumi.Int(0),
TypeScale: pulumi.Int(0),
TypeText: pulumi.String("string"),
},
},
},
TableLocalDetails: &databricks.CleanRoomAssetTableLocalDetailsArgs{
LocalName: pulumi.String("string"),
Partitions: databricks.CleanRoomAssetTableLocalDetailsPartitionArray{
&databricks.CleanRoomAssetTableLocalDetailsPartitionArgs{
Values: databricks.CleanRoomAssetTableLocalDetailsPartitionValueArray{
&databricks.CleanRoomAssetTableLocalDetailsPartitionValueArgs{
Name: pulumi.String("string"),
Op: pulumi.String("string"),
RecipientPropertyKey: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
},
View: &databricks.CleanRoomAssetViewArgs{
Columns: databricks.CleanRoomAssetViewColumnArray{
&databricks.CleanRoomAssetViewColumnArgs{
Comment: pulumi.String("string"),
Mask: &databricks.CleanRoomAssetViewColumnMaskArgs{
FunctionName: pulumi.String("string"),
UsingColumnNames: pulumi.StringArray{
pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Nullable: pulumi.Bool(false),
PartitionIndex: pulumi.Int(0),
Position: pulumi.Int(0),
TypeIntervalType: pulumi.String("string"),
TypeJson: pulumi.String("string"),
TypeName: pulumi.String("string"),
TypePrecision: pulumi.Int(0),
TypeScale: pulumi.Int(0),
TypeText: pulumi.String("string"),
},
},
},
ViewLocalDetails: &databricks.CleanRoomAssetViewLocalDetailsArgs{
LocalName: pulumi.String("string"),
},
VolumeLocalDetails: &databricks.CleanRoomAssetVolumeLocalDetailsArgs{
LocalName: pulumi.String("string"),
},
})
var cleanRoomAssetResource = new CleanRoomAsset("cleanRoomAssetResource", CleanRoomAssetArgs.builder()
.assetType("string")
.cleanRoomName("string")
.foreignTable(CleanRoomAssetForeignTableArgs.builder()
.columns(CleanRoomAssetForeignTableColumnArgs.builder()
.comment("string")
.mask(CleanRoomAssetForeignTableColumnMaskArgs.builder()
.functionName("string")
.usingColumnNames("string")
.build())
.name("string")
.nullable(false)
.partitionIndex(0)
.position(0)
.typeIntervalType("string")
.typeJson("string")
.typeName("string")
.typePrecision(0)
.typeScale(0)
.typeText("string")
.build())
.build())
.foreignTableLocalDetails(CleanRoomAssetForeignTableLocalDetailsArgs.builder()
.localName("string")
.build())
.name("string")
.notebook(CleanRoomAssetNotebookArgs.builder()
.notebookContent("string")
.etag("string")
.reviewState("string")
.reviews(CleanRoomAssetNotebookReviewArgs.builder()
.comment("string")
.createdAtMillis(0)
.reviewState("string")
.reviewSubReason("string")
.reviewerCollaboratorAlias("string")
.build())
.runnerCollaboratorAliases("string")
.build())
.table(CleanRoomAssetTableArgs.builder()
.columns(CleanRoomAssetTableColumnArgs.builder()
.comment("string")
.mask(CleanRoomAssetTableColumnMaskArgs.builder()
.functionName("string")
.usingColumnNames("string")
.build())
.name("string")
.nullable(false)
.partitionIndex(0)
.position(0)
.typeIntervalType("string")
.typeJson("string")
.typeName("string")
.typePrecision(0)
.typeScale(0)
.typeText("string")
.build())
.build())
.tableLocalDetails(CleanRoomAssetTableLocalDetailsArgs.builder()
.localName("string")
.partitions(CleanRoomAssetTableLocalDetailsPartitionArgs.builder()
.values(CleanRoomAssetTableLocalDetailsPartitionValueArgs.builder()
.name("string")
.op("string")
.recipientPropertyKey("string")
.value("string")
.build())
.build())
.build())
.view(CleanRoomAssetViewArgs.builder()
.columns(CleanRoomAssetViewColumnArgs.builder()
.comment("string")
.mask(CleanRoomAssetViewColumnMaskArgs.builder()
.functionName("string")
.usingColumnNames("string")
.build())
.name("string")
.nullable(false)
.partitionIndex(0)
.position(0)
.typeIntervalType("string")
.typeJson("string")
.typeName("string")
.typePrecision(0)
.typeScale(0)
.typeText("string")
.build())
.build())
.viewLocalDetails(CleanRoomAssetViewLocalDetailsArgs.builder()
.localName("string")
.build())
.volumeLocalDetails(CleanRoomAssetVolumeLocalDetailsArgs.builder()
.localName("string")
.build())
.build());
clean_room_asset_resource = databricks.CleanRoomAsset("cleanRoomAssetResource",
asset_type="string",
clean_room_name="string",
foreign_table={
"columns": [{
"comment": "string",
"mask": {
"function_name": "string",
"using_column_names": ["string"],
},
"name": "string",
"nullable": False,
"partition_index": 0,
"position": 0,
"type_interval_type": "string",
"type_json": "string",
"type_name": "string",
"type_precision": 0,
"type_scale": 0,
"type_text": "string",
}],
},
foreign_table_local_details={
"local_name": "string",
},
name="string",
notebook={
"notebook_content": "string",
"etag": "string",
"review_state": "string",
"reviews": [{
"comment": "string",
"created_at_millis": 0,
"review_state": "string",
"review_sub_reason": "string",
"reviewer_collaborator_alias": "string",
}],
"runner_collaborator_aliases": ["string"],
},
table={
"columns": [{
"comment": "string",
"mask": {
"function_name": "string",
"using_column_names": ["string"],
},
"name": "string",
"nullable": False,
"partition_index": 0,
"position": 0,
"type_interval_type": "string",
"type_json": "string",
"type_name": "string",
"type_precision": 0,
"type_scale": 0,
"type_text": "string",
}],
},
table_local_details={
"local_name": "string",
"partitions": [{
"values": [{
"name": "string",
"op": "string",
"recipient_property_key": "string",
"value": "string",
}],
}],
},
view={
"columns": [{
"comment": "string",
"mask": {
"function_name": "string",
"using_column_names": ["string"],
},
"name": "string",
"nullable": False,
"partition_index": 0,
"position": 0,
"type_interval_type": "string",
"type_json": "string",
"type_name": "string",
"type_precision": 0,
"type_scale": 0,
"type_text": "string",
}],
},
view_local_details={
"local_name": "string",
},
volume_local_details={
"local_name": "string",
})
const cleanRoomAssetResource = new databricks.CleanRoomAsset("cleanRoomAssetResource", {
assetType: "string",
cleanRoomName: "string",
foreignTable: {
columns: [{
comment: "string",
mask: {
functionName: "string",
usingColumnNames: ["string"],
},
name: "string",
nullable: false,
partitionIndex: 0,
position: 0,
typeIntervalType: "string",
typeJson: "string",
typeName: "string",
typePrecision: 0,
typeScale: 0,
typeText: "string",
}],
},
foreignTableLocalDetails: {
localName: "string",
},
name: "string",
notebook: {
notebookContent: "string",
etag: "string",
reviewState: "string",
reviews: [{
comment: "string",
createdAtMillis: 0,
reviewState: "string",
reviewSubReason: "string",
reviewerCollaboratorAlias: "string",
}],
runnerCollaboratorAliases: ["string"],
},
table: {
columns: [{
comment: "string",
mask: {
functionName: "string",
usingColumnNames: ["string"],
},
name: "string",
nullable: false,
partitionIndex: 0,
position: 0,
typeIntervalType: "string",
typeJson: "string",
typeName: "string",
typePrecision: 0,
typeScale: 0,
typeText: "string",
}],
},
tableLocalDetails: {
localName: "string",
partitions: [{
values: [{
name: "string",
op: "string",
recipientPropertyKey: "string",
value: "string",
}],
}],
},
view: {
columns: [{
comment: "string",
mask: {
functionName: "string",
usingColumnNames: ["string"],
},
name: "string",
nullable: false,
partitionIndex: 0,
position: 0,
typeIntervalType: "string",
typeJson: "string",
typeName: "string",
typePrecision: 0,
typeScale: 0,
typeText: "string",
}],
},
viewLocalDetails: {
localName: "string",
},
volumeLocalDetails: {
localName: "string",
},
});
type: databricks:CleanRoomAsset
properties:
assetType: string
cleanRoomName: string
foreignTable:
columns:
- comment: string
mask:
functionName: string
usingColumnNames:
- string
name: string
nullable: false
partitionIndex: 0
position: 0
typeIntervalType: string
typeJson: string
typeName: string
typePrecision: 0
typeScale: 0
typeText: string
foreignTableLocalDetails:
localName: string
name: string
notebook:
etag: string
notebookContent: string
reviewState: string
reviews:
- comment: string
createdAtMillis: 0
reviewState: string
reviewSubReason: string
reviewerCollaboratorAlias: string
runnerCollaboratorAliases:
- string
table:
columns:
- comment: string
mask:
functionName: string
usingColumnNames:
- string
name: string
nullable: false
partitionIndex: 0
position: 0
typeIntervalType: string
typeJson: string
typeName: string
typePrecision: 0
typeScale: 0
typeText: string
tableLocalDetails:
localName: string
partitions:
- values:
- name: string
op: string
recipientPropertyKey: string
value: string
view:
columns:
- comment: string
mask:
functionName: string
usingColumnNames:
- string
name: string
nullable: false
partitionIndex: 0
position: 0
typeIntervalType: string
typeJson: string
typeName: string
typePrecision: 0
typeScale: 0
typeText: string
viewLocalDetails:
localName: string
volumeLocalDetails:
localName: string
CleanRoomAsset Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CleanRoomAsset resource accepts the following input properties:
- Asset
Type string - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- Clean
Room stringName - 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 CleanRoom Asset Foreign Table - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- Foreign
Table CleanLocal Details Room Asset Foreign Table Local Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- Notebook
Clean
Room Asset Notebook - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- Table
Clean
Room Asset Table - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- Table
Local CleanDetails Room Asset Table Local Details - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- View
Clean
Room Asset View - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- View
Local CleanDetails Room Asset View Local Details - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- Volume
Local CleanDetails Room Asset Volume Local Details - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- Asset
Type string - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- Clean
Room stringName - 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 CleanRoom Asset Foreign Table Args - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- Foreign
Table CleanLocal Details Room Asset Foreign Table Local Details Args - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- Notebook
Clean
Room Asset Notebook Args - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- Table
Clean
Room Asset Table Args - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- Table
Local CleanDetails Room Asset Table Local Details Args - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- View
Clean
Room Asset View Args - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- View
Local CleanDetails Room Asset View Local Details Args - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- Volume
Local CleanDetails Room Asset Volume Local Details Args - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- asset
Type String - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean
Room StringName - 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 CleanRoom Asset Foreign Table - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign
Table CleanLocal Details Room Asset Foreign Table Local Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook
Clean
Room Asset Notebook - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- table
Clean
Room Asset Table - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table
Local CleanDetails Room Asset Table Local Details - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view
Clean
Room Asset View - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view
Local CleanDetails Room Asset View Local Details - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume
Local CleanDetails Room Asset Volume Local Details - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- asset
Type string - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean
Room stringName - 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 CleanRoom Asset Foreign Table - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign
Table CleanLocal Details Room Asset Foreign Table Local Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook
Clean
Room Asset Notebook - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- table
Clean
Room Asset Table - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table
Local CleanDetails Room Asset Table Local Details - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view
Clean
Room Asset View - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view
Local CleanDetails Room Asset View Local Details - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume
Local CleanDetails Room Asset Volume Local Details - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- asset_
type str - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean_
room_ strname - 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 CleanRoom Asset Foreign Table Args - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign_
table_ Cleanlocal_ details Room Asset Foreign Table Local Details Args - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook
Clean
Room Asset Notebook Args - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- table
Clean
Room Asset Table Args - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table_
local_ Cleandetails Room Asset Table Local Details Args - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view
Clean
Room Asset View Args - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view_
local_ Cleandetails Room Asset View Local Details Args - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume_
local_ Cleandetails Room Asset Volume Local Details Args - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- asset
Type String - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean
Room StringName - 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 Property Map - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign
Table Property MapLocal Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook Property Map
- Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- table Property Map
- Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table
Local Property MapDetails - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view Property Map
- View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view
Local Property MapDetails - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume
Local Property MapDetails - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
Outputs
All input properties are implicitly available as output properties. Additionally, the CleanRoomAsset resource produces the following output properties:
- Added
At int - (integer) - When the asset is added to the clean room, in epoch milliseconds
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner
Collaborator stringAlias - (string) - The alias of the collaborator who owns this asset
- Status string
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- Added
At int - (integer) - When the asset is added to the clean room, in epoch milliseconds
- Id string
- The provider-assigned unique ID for this managed resource.
- Owner
Collaborator stringAlias - (string) - The alias of the collaborator who owns this asset
- Status string
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- added
At Integer - (integer) - When the asset is added to the clean room, in epoch milliseconds
- id String
- The provider-assigned unique ID for this managed resource.
- owner
Collaborator StringAlias - (string) - The alias of the collaborator who owns this asset
- status String
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- added
At number - (integer) - When the asset is added to the clean room, in epoch milliseconds
- id string
- The provider-assigned unique ID for this managed resource.
- owner
Collaborator stringAlias - (string) - The alias of the collaborator who owns this asset
- status string
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- added_
at int - (integer) - When the asset is added to the clean room, in epoch milliseconds
- id str
- The provider-assigned unique ID for this managed resource.
- owner_
collaborator_ stralias - (string) - The alias of the collaborator who owns this asset
- status str
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- added
At Number - (integer) - When the asset is added to the clean room, in epoch milliseconds
- id String
- The provider-assigned unique ID for this managed resource.
- owner
Collaborator StringAlias - (string) - The alias of the collaborator who owns this asset
- status String
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
Look up Existing CleanRoomAsset Resource
Get an existing CleanRoomAsset resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CleanRoomAssetState, opts?: CustomResourceOptions): CleanRoomAsset
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
added_at: Optional[int] = None,
asset_type: Optional[str] = None,
clean_room_name: Optional[str] = None,
foreign_table: Optional[CleanRoomAssetForeignTableArgs] = None,
foreign_table_local_details: Optional[CleanRoomAssetForeignTableLocalDetailsArgs] = None,
name: Optional[str] = None,
notebook: Optional[CleanRoomAssetNotebookArgs] = None,
owner_collaborator_alias: Optional[str] = None,
status: Optional[str] = None,
table: Optional[CleanRoomAssetTableArgs] = None,
table_local_details: Optional[CleanRoomAssetTableLocalDetailsArgs] = None,
view: Optional[CleanRoomAssetViewArgs] = None,
view_local_details: Optional[CleanRoomAssetViewLocalDetailsArgs] = None,
volume_local_details: Optional[CleanRoomAssetVolumeLocalDetailsArgs] = None) -> CleanRoomAsset
func GetCleanRoomAsset(ctx *Context, name string, id IDInput, state *CleanRoomAssetState, opts ...ResourceOption) (*CleanRoomAsset, error)
public static CleanRoomAsset Get(string name, Input<string> id, CleanRoomAssetState? state, CustomResourceOptions? opts = null)
public static CleanRoomAsset get(String name, Output<String> id, CleanRoomAssetState state, CustomResourceOptions options)
resources: _: type: databricks:CleanRoomAsset get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Added
At int - (integer) - When the asset is added to the clean room, in epoch milliseconds
- Asset
Type string - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- Clean
Room stringName - 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 CleanRoom Asset Foreign Table - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- Foreign
Table CleanLocal Details Room Asset Foreign Table Local Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- Notebook
Clean
Room Asset Notebook - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- Owner
Collaborator stringAlias - (string) - The alias of the collaborator who owns this asset
- Status string
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- Table
Clean
Room Asset Table - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- Table
Local CleanDetails Room Asset Table Local Details - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- View
Clean
Room Asset View - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- View
Local CleanDetails Room Asset View Local Details - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- Volume
Local CleanDetails Room Asset Volume Local Details - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- Added
At int - (integer) - When the asset is added to the clean room, in epoch milliseconds
- Asset
Type string - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- Clean
Room stringName - 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 CleanRoom Asset Foreign Table Args - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- Foreign
Table CleanLocal Details Room Asset Foreign Table Local Details Args - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- Notebook
Clean
Room Asset Notebook Args - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- Owner
Collaborator stringAlias - (string) - The alias of the collaborator who owns this asset
- Status string
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- Table
Clean
Room Asset Table Args - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- Table
Local CleanDetails Room Asset Table Local Details Args - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- View
Clean
Room Asset View Args - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- View
Local CleanDetails Room Asset View Local Details Args - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- Volume
Local CleanDetails Room Asset Volume Local Details Args - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- added
At Integer - (integer) - When the asset is added to the clean room, in epoch milliseconds
- asset
Type String - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean
Room StringName - 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 CleanRoom Asset Foreign Table - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign
Table CleanLocal Details Room Asset Foreign Table Local Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook
Clean
Room Asset Notebook - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- owner
Collaborator StringAlias - (string) - The alias of the collaborator who owns this asset
- status String
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- table
Clean
Room Asset Table - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table
Local CleanDetails Room Asset Table Local Details - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view
Clean
Room Asset View - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view
Local CleanDetails Room Asset View Local Details - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume
Local CleanDetails Room Asset Volume Local Details - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- added
At number - (integer) - When the asset is added to the clean room, in epoch milliseconds
- asset
Type string - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean
Room stringName - 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 CleanRoom Asset Foreign Table - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign
Table CleanLocal Details Room Asset Foreign Table Local Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook
Clean
Room Asset Notebook - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- owner
Collaborator stringAlias - (string) - The alias of the collaborator who owns this asset
- status string
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- table
Clean
Room Asset Table - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table
Local CleanDetails Room Asset Table Local Details - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view
Clean
Room Asset View - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view
Local CleanDetails Room Asset View Local Details - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume
Local CleanDetails Room Asset Volume Local Details - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- added_
at int - (integer) - When the asset is added to the clean room, in epoch milliseconds
- asset_
type str - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean_
room_ strname - 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 CleanRoom Asset Foreign Table Args - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign_
table_ Cleanlocal_ details Room Asset Foreign Table Local Details Args - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook
Clean
Room Asset Notebook Args - Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- owner_
collaborator_ stralias - (string) - The alias of the collaborator who owns this asset
- status str
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- table
Clean
Room Asset Table Args - Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table_
local_ Cleandetails Room Asset Table Local Details Args - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view
Clean
Room Asset View Args - View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view_
local_ Cleandetails Room Asset View Local Details Args - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume_
local_ Cleandetails Room Asset Volume Local Details Args - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
- added
At Number - (integer) - When the asset is added to the clean room, in epoch milliseconds
- asset
Type String - The type of the asset. Possible values are:
FOREIGN_TABLE
,NOTEBOOK_FILE
,TABLE
,VIEW
,VOLUME
- clean
Room StringName - 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 Property Map - Foreign table details available to all collaborators of the clean room. Present if and only if asset_type is FOREIGN_TABLE
- foreign
Table Property MapLocal Details - Local details for a foreign that are only available to its owner. Present if and only if asset_type is FOREIGN_TABLE
- 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
- notebook Property Map
- Notebook details available to all collaborators of the clean room. Present if and only if asset_type is NOTEBOOK_FILE
- owner
Collaborator StringAlias - (string) - The alias of the collaborator who owns this asset
- status String
- (string) - Status of the asset. Possible values are:
ACTIVE
,PENDING
,PERMISSION_DENIED
- table Property Map
- Table details available to all collaborators of the clean room. Present if and only if asset_type is TABLE
- table
Local Property MapDetails - Local details for a table that are only available to its owner. Present if and only if asset_type is TABLE
- view Property Map
- View details available to all collaborators of the clean room. Present if and only if asset_type is VIEW
- view
Local Property MapDetails - Local details for a view that are only available to its owner. Present if and only if asset_type is VIEW
- volume
Local Property MapDetails - Local details for a volume that are only available to its owner. Present if and only if asset_type is VOLUME
Supporting Types
CleanRoomAssetForeignTable, CleanRoomAssetForeignTableArgs
- Columns
List<Clean
Room Asset Foreign Table Column> - (list of ColumnInfo) - The metadata information of the columns in the view
- Columns
[]Clean
Room Asset Foreign Table Column - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
List<Clean
Room Asset Foreign Table Column> - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
Clean
Room Asset Foreign Table Column[] - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
Sequence[Clean
Room Asset Foreign Table Column] - (list of ColumnInfo) - The metadata information of the columns in the view
- columns List<Property Map>
- (list of ColumnInfo) - The metadata information of the columns in the view
CleanRoomAssetForeignTableColumn, CleanRoomAssetForeignTableColumnArgs
- Comment string
- Mask
Clean
Room Asset Foreign Table Column Mask - 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
- Nullable bool
- Whether field may be Null (default: true)
- Partition
Index int - Partition index for column
- Position int
- Ordinal position of column (starting at position 0)
- Type
Interval stringType - Format of IntervalType
- Type
Json string - Full data type specification, JSON-serialized
- Type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- Type
Precision int - Digits of precision; required for DecimalTypes
- Type
Scale int - Digits to right of decimal; Required for DecimalTypes
- Type
Text string - Full data type specification as SQL/catalogString text
- Comment string
- Mask
Clean
Room Asset Foreign Table Column Mask - 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
- Nullable bool
- Whether field may be Null (default: true)
- Partition
Index int - Partition index for column
- Position int
- Ordinal position of column (starting at position 0)
- Type
Interval stringType - Format of IntervalType
- Type
Json string - Full data type specification, JSON-serialized
- Type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- Type
Precision int - Digits of precision; required for DecimalTypes
- Type
Scale int - Digits to right of decimal; Required for DecimalTypes
- Type
Text string - Full data type specification as SQL/catalogString text
- comment String
- mask
Clean
Room Asset Foreign Table Column Mask - 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
- nullable Boolean
- Whether field may be Null (default: true)
- partition
Index Integer - Partition index for column
- position Integer
- Ordinal position of column (starting at position 0)
- type
Interval StringType - Format of IntervalType
- type
Json String - Full data type specification, JSON-serialized
- type
Name String - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision Integer - Digits of precision; required for DecimalTypes
- type
Scale Integer - Digits to right of decimal; Required for DecimalTypes
- type
Text String - Full data type specification as SQL/catalogString text
- comment string
- mask
Clean
Room Asset Foreign Table Column Mask - 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
- nullable boolean
- Whether field may be Null (default: true)
- partition
Index number - Partition index for column
- position number
- Ordinal position of column (starting at position 0)
- type
Interval stringType - Format of IntervalType
- type
Json string - Full data type specification, JSON-serialized
- type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision number - Digits of precision; required for DecimalTypes
- type
Scale number - Digits to right of decimal; Required for DecimalTypes
- type
Text string - Full data type specification as SQL/catalogString text
- comment str
- mask
Clean
Room Asset Foreign Table Column Mask - 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
- nullable bool
- Whether field may be Null (default: true)
- partition_
index int - Partition index for column
- position int
- Ordinal position of column (starting at position 0)
- type_
interval_ strtype - Format of IntervalType
- type_
json str - Full data type specification, JSON-serialized
- type_
name str - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type_
precision int - Digits of precision; required for DecimalTypes
- type_
scale int - Digits to right of decimal; Required for DecimalTypes
- type_
text str - Full data type specification as SQL/catalogString text
- comment String
- mask Property Map
- 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
- nullable Boolean
- Whether field may be Null (default: true)
- partition
Index Number - Partition index for column
- position Number
- Ordinal position of column (starting at position 0)
- type
Interval StringType - Format of IntervalType
- type
Json String - Full data type specification, JSON-serialized
- type
Name String - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision Number - Digits of precision; required for DecimalTypes
- type
Scale Number - Digits to right of decimal; Required for DecimalTypes
- type
Text String - Full data type specification as SQL/catalogString text
CleanRoomAssetForeignTableColumnMask, CleanRoomAssetForeignTableColumnMaskArgs
- Function
Name string - The full name of the column mask SQL UDF
- Using
Column List<string>Names - 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'
- Function
Name string - The full name of the column mask SQL UDF
- Using
Column []stringNames - 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'
- function
Name String - The full name of the column mask SQL UDF
- using
Column List<String>Names - 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'
- function
Name string - The full name of the column mask SQL UDF
- using
Column string[]Names - 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'
- function_
name str - The full name of the column mask SQL UDF
- using_
column_ Sequence[str]names - 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'
- function
Name String - The full name of the column mask SQL UDF
- using
Column List<String>Names - 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'
CleanRoomAssetForeignTableLocalDetails, CleanRoomAssetForeignTableLocalDetailsArgs
- Local
Name string
- Local
Name string
- local
Name String
- local
Name string
- local_
name str
- local
Name String
CleanRoomAssetNotebook, CleanRoomAssetNotebookArgs
- Notebook
Content string - Base 64 representation of the notebook contents. This is the same format as returned by :method:workspace/export with the format of HTML
- Etag string
- (string) - Server generated etag that represents the notebook version
- Review
State string - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- Reviews
List<Clean
Room Asset Notebook Review> - (list of CleanRoomNotebookReview) - All existing approvals or rejections
- Runner
Collaborator List<string>Aliases - collaborators that can run the notebook
- Notebook
Content string - Base 64 representation of the notebook contents. This is the same format as returned by :method:workspace/export with the format of HTML
- Etag string
- (string) - Server generated etag that represents the notebook version
- Review
State string - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- Reviews
[]Clean
Room Asset Notebook Review - (list of CleanRoomNotebookReview) - All existing approvals or rejections
- Runner
Collaborator []stringAliases - collaborators that can run the notebook
- notebook
Content String - Base 64 representation of the notebook contents. This is the same format as returned by :method:workspace/export with the format of HTML
- etag String
- (string) - Server generated etag that represents the notebook version
- review
State String - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- reviews
List<Clean
Room Asset Notebook Review> - (list of CleanRoomNotebookReview) - All existing approvals or rejections
- runner
Collaborator List<String>Aliases - collaborators that can run the notebook
- notebook
Content string - Base 64 representation of the notebook contents. This is the same format as returned by :method:workspace/export with the format of HTML
- etag string
- (string) - Server generated etag that represents the notebook version
- review
State string - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- reviews
Clean
Room Asset Notebook Review[] - (list of CleanRoomNotebookReview) - All existing approvals or rejections
- runner
Collaborator string[]Aliases - collaborators that can run the notebook
- 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
- (string) - Server generated etag that represents the notebook version
- review_
state str - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- reviews
Sequence[Clean
Room Asset Notebook Review] - (list of CleanRoomNotebookReview) - All existing approvals or rejections
- runner_
collaborator_ Sequence[str]aliases - collaborators that can run the notebook
- notebook
Content String - Base 64 representation of the notebook contents. This is the same format as returned by :method:workspace/export with the format of HTML
- etag String
- (string) - Server generated etag that represents the notebook version
- review
State String - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- reviews List<Property Map>
- (list of CleanRoomNotebookReview) - All existing approvals or rejections
- runner
Collaborator List<String>Aliases - collaborators that can run the notebook
CleanRoomAssetNotebookReview, CleanRoomAssetNotebookReviewArgs
- Comment string
- Created
At intMillis - When the review was submitted, in epoch milliseconds
- Review
State string - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- Review
Sub stringReason - Specified when the review was not explicitly made by a user. Possible values are:
AUTO_APPROVED
,BACKFILLED
- Reviewer
Collaborator stringAlias - Collaborator alias of the reviewer
- Comment string
- Created
At intMillis - When the review was submitted, in epoch milliseconds
- Review
State string - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- Review
Sub stringReason - Specified when the review was not explicitly made by a user. Possible values are:
AUTO_APPROVED
,BACKFILLED
- Reviewer
Collaborator stringAlias - Collaborator alias of the reviewer
- comment String
- created
At IntegerMillis - When the review was submitted, in epoch milliseconds
- review
State String - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- review
Sub StringReason - Specified when the review was not explicitly made by a user. Possible values are:
AUTO_APPROVED
,BACKFILLED
- reviewer
Collaborator StringAlias - Collaborator alias of the reviewer
- comment string
- created
At numberMillis - When the review was submitted, in epoch milliseconds
- review
State string - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- review
Sub stringReason - Specified when the review was not explicitly made by a user. Possible values are:
AUTO_APPROVED
,BACKFILLED
- reviewer
Collaborator stringAlias - Collaborator alias of the reviewer
- comment str
- created_
at_ intmillis - When the review was submitted, in epoch milliseconds
- review_
state str - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- review_
sub_ strreason - Specified when the review was not explicitly made by a user. Possible values are:
AUTO_APPROVED
,BACKFILLED
- reviewer_
collaborator_ stralias - Collaborator alias of the reviewer
- comment String
- created
At NumberMillis - When the review was submitted, in epoch milliseconds
- review
State String - (string) - Top-level status derived from all reviews. Possible values are:
APPROVED
,PENDING
,REJECTED
- review
Sub StringReason - Specified when the review was not explicitly made by a user. Possible values are:
AUTO_APPROVED
,BACKFILLED
- reviewer
Collaborator StringAlias - Collaborator alias of the reviewer
CleanRoomAssetTable, CleanRoomAssetTableArgs
- Columns
List<Clean
Room Asset Table Column> - (list of ColumnInfo) - The metadata information of the columns in the view
- Columns
[]Clean
Room Asset Table Column - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
List<Clean
Room Asset Table Column> - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
Clean
Room Asset Table Column[] - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
Sequence[Clean
Room Asset Table Column] - (list of ColumnInfo) - The metadata information of the columns in the view
- columns List<Property Map>
- (list of ColumnInfo) - The metadata information of the columns in the view
CleanRoomAssetTableColumn, CleanRoomAssetTableColumnArgs
- Comment string
- Mask
Clean
Room Asset Table Column Mask - 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
- Nullable bool
- Whether field may be Null (default: true)
- Partition
Index int - Partition index for column
- Position int
- Ordinal position of column (starting at position 0)
- Type
Interval stringType - Format of IntervalType
- Type
Json string - Full data type specification, JSON-serialized
- Type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- Type
Precision int - Digits of precision; required for DecimalTypes
- Type
Scale int - Digits to right of decimal; Required for DecimalTypes
- Type
Text string - Full data type specification as SQL/catalogString text
- Comment string
- Mask
Clean
Room Asset Table Column Mask - 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
- Nullable bool
- Whether field may be Null (default: true)
- Partition
Index int - Partition index for column
- Position int
- Ordinal position of column (starting at position 0)
- Type
Interval stringType - Format of IntervalType
- Type
Json string - Full data type specification, JSON-serialized
- Type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- Type
Precision int - Digits of precision; required for DecimalTypes
- Type
Scale int - Digits to right of decimal; Required for DecimalTypes
- Type
Text string - Full data type specification as SQL/catalogString text
- comment String
- mask
Clean
Room Asset Table Column Mask - 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
- nullable Boolean
- Whether field may be Null (default: true)
- partition
Index Integer - Partition index for column
- position Integer
- Ordinal position of column (starting at position 0)
- type
Interval StringType - Format of IntervalType
- type
Json String - Full data type specification, JSON-serialized
- type
Name String - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision Integer - Digits of precision; required for DecimalTypes
- type
Scale Integer - Digits to right of decimal; Required for DecimalTypes
- type
Text String - Full data type specification as SQL/catalogString text
- comment string
- mask
Clean
Room Asset Table Column Mask - 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
- nullable boolean
- Whether field may be Null (default: true)
- partition
Index number - Partition index for column
- position number
- Ordinal position of column (starting at position 0)
- type
Interval stringType - Format of IntervalType
- type
Json string - Full data type specification, JSON-serialized
- type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision number - Digits of precision; required for DecimalTypes
- type
Scale number - Digits to right of decimal; Required for DecimalTypes
- type
Text string - Full data type specification as SQL/catalogString text
- comment str
- mask
Clean
Room Asset Table Column Mask - 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
- nullable bool
- Whether field may be Null (default: true)
- partition_
index int - Partition index for column
- position int
- Ordinal position of column (starting at position 0)
- type_
interval_ strtype - Format of IntervalType
- type_
json str - Full data type specification, JSON-serialized
- type_
name str - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type_
precision int - Digits of precision; required for DecimalTypes
- type_
scale int - Digits to right of decimal; Required for DecimalTypes
- type_
text str - Full data type specification as SQL/catalogString text
- comment String
- mask Property Map
- 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
- nullable Boolean
- Whether field may be Null (default: true)
- partition
Index Number - Partition index for column
- position Number
- Ordinal position of column (starting at position 0)
- type
Interval StringType - Format of IntervalType
- type
Json String - Full data type specification, JSON-serialized
- type
Name String - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision Number - Digits of precision; required for DecimalTypes
- type
Scale Number - Digits to right of decimal; Required for DecimalTypes
- type
Text String - Full data type specification as SQL/catalogString text
CleanRoomAssetTableColumnMask, CleanRoomAssetTableColumnMaskArgs
- Function
Name string - The full name of the column mask SQL UDF
- Using
Column List<string>Names - 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'
- Function
Name string - The full name of the column mask SQL UDF
- Using
Column []stringNames - 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'
- function
Name String - The full name of the column mask SQL UDF
- using
Column List<String>Names - 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'
- function
Name string - The full name of the column mask SQL UDF
- using
Column string[]Names - 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'
- function_
name str - The full name of the column mask SQL UDF
- using_
column_ Sequence[str]names - 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'
- function
Name String - The full name of the column mask SQL UDF
- using
Column List<String>Names - 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'
CleanRoomAssetTableLocalDetails, CleanRoomAssetTableLocalDetailsArgs
- Local
Name string - Partitions
List<Clean
Room Asset Table Local Details Partition> - Partition filtering specification for a shared table
- Local
Name string - Partitions
[]Clean
Room Asset Table Local Details Partition - Partition filtering specification for a shared table
- local
Name String - partitions
List<Clean
Room Asset Table Local Details Partition> - Partition filtering specification for a shared table
- local
Name string - partitions
Clean
Room Asset Table Local Details Partition[] - Partition filtering specification for a shared table
- local_
name str - partitions
Sequence[Clean
Room Asset Table Local Details Partition] - Partition filtering specification for a shared table
- local
Name String - partitions List<Property Map>
- Partition filtering specification for a shared table
CleanRoomAssetTableLocalDetailsPartition, CleanRoomAssetTableLocalDetailsPartitionArgs
- Values
List<Clean
Room Asset Table Local Details Partition Value> - The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- Values
[]Clean
Room Asset Table Local Details Partition Value - The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- values
List<Clean
Room Asset Table Local Details Partition Value> - The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- values
Clean
Room Asset Table Local Details Partition Value[] - The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- values
Sequence[Clean
Room Asset Table Local Details Partition Value] - The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- values List<Property Map>
- The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
CleanRoomAssetTableLocalDetailsPartitionValue, CleanRoomAssetTableLocalDetailsPartitionValueArgs
- 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
- Op string
- The operator to apply for the value. Possible values are:
EQUAL
,LIKE
- Recipient
Property stringKey - 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 - Value string
- The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- 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
- Op string
- The operator to apply for the value. Possible values are:
EQUAL
,LIKE
- Recipient
Property stringKey - 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 - Value string
- The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- 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
- op String
- The operator to apply for the value. Possible values are:
EQUAL
,LIKE
- recipient
Property StringKey - 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 - value String
- The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- 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
- op string
- The operator to apply for the value. Possible values are:
EQUAL
,LIKE
- recipient
Property stringKey - 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 - value string
- The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- 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
- op str
- The operator to apply for the value. Possible values are:
EQUAL
,LIKE
- recipient_
property_ strkey - 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 - value str
- The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
- 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
- op String
- The operator to apply for the value. Possible values are:
EQUAL
,LIKE
- recipient
Property StringKey - 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 - value String
- The value of the partition column. When this value is not set, it means
null
value. When this field is set, fieldrecipient_property_key
can not be set
CleanRoomAssetView, CleanRoomAssetViewArgs
- Columns
List<Clean
Room Asset View Column> - (list of ColumnInfo) - The metadata information of the columns in the view
- Columns
[]Clean
Room Asset View Column - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
List<Clean
Room Asset View Column> - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
Clean
Room Asset View Column[] - (list of ColumnInfo) - The metadata information of the columns in the view
- columns
Sequence[Clean
Room Asset View Column] - (list of ColumnInfo) - The metadata information of the columns in the view
- columns List<Property Map>
- (list of ColumnInfo) - The metadata information of the columns in the view
CleanRoomAssetViewColumn, CleanRoomAssetViewColumnArgs
- Comment string
- Mask
Clean
Room Asset View Column Mask - 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
- Nullable bool
- Whether field may be Null (default: true)
- Partition
Index int - Partition index for column
- Position int
- Ordinal position of column (starting at position 0)
- Type
Interval stringType - Format of IntervalType
- Type
Json string - Full data type specification, JSON-serialized
- Type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- Type
Precision int - Digits of precision; required for DecimalTypes
- Type
Scale int - Digits to right of decimal; Required for DecimalTypes
- Type
Text string - Full data type specification as SQL/catalogString text
- Comment string
- Mask
Clean
Room Asset View Column Mask - 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
- Nullable bool
- Whether field may be Null (default: true)
- Partition
Index int - Partition index for column
- Position int
- Ordinal position of column (starting at position 0)
- Type
Interval stringType - Format of IntervalType
- Type
Json string - Full data type specification, JSON-serialized
- Type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- Type
Precision int - Digits of precision; required for DecimalTypes
- Type
Scale int - Digits to right of decimal; Required for DecimalTypes
- Type
Text string - Full data type specification as SQL/catalogString text
- comment String
- mask
Clean
Room Asset View Column Mask - 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
- nullable Boolean
- Whether field may be Null (default: true)
- partition
Index Integer - Partition index for column
- position Integer
- Ordinal position of column (starting at position 0)
- type
Interval StringType - Format of IntervalType
- type
Json String - Full data type specification, JSON-serialized
- type
Name String - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision Integer - Digits of precision; required for DecimalTypes
- type
Scale Integer - Digits to right of decimal; Required for DecimalTypes
- type
Text String - Full data type specification as SQL/catalogString text
- comment string
- mask
Clean
Room Asset View Column Mask - 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
- nullable boolean
- Whether field may be Null (default: true)
- partition
Index number - Partition index for column
- position number
- Ordinal position of column (starting at position 0)
- type
Interval stringType - Format of IntervalType
- type
Json string - Full data type specification, JSON-serialized
- type
Name string - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision number - Digits of precision; required for DecimalTypes
- type
Scale number - Digits to right of decimal; Required for DecimalTypes
- type
Text string - Full data type specification as SQL/catalogString text
- comment str
- mask
Clean
Room Asset View Column Mask - 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
- nullable bool
- Whether field may be Null (default: true)
- partition_
index int - Partition index for column
- position int
- Ordinal position of column (starting at position 0)
- type_
interval_ strtype - Format of IntervalType
- type_
json str - Full data type specification, JSON-serialized
- type_
name str - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type_
precision int - Digits of precision; required for DecimalTypes
- type_
scale int - Digits to right of decimal; Required for DecimalTypes
- type_
text str - Full data type specification as SQL/catalogString text
- comment String
- mask Property Map
- 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
- nullable Boolean
- Whether field may be Null (default: true)
- partition
Index Number - Partition index for column
- position Number
- Ordinal position of column (starting at position 0)
- type
Interval StringType - Format of IntervalType
- type
Json String - Full data type specification, JSON-serialized
- type
Name String - . Possible values are:
ARRAY
,BINARY
,BOOLEAN
,BYTE
,CHAR
,DATE
,DECIMAL
,DOUBLE
,FLOAT
,GEOGRAPHY
,GEOMETRY
,INT
,INTERVAL
,LONG
,MAP
,NULL
,SHORT
,STRING
,STRUCT
,TABLE_TYPE
,TIMESTAMP
,TIMESTAMP_NTZ
,USER_DEFINED_TYPE
,VARIANT
- type
Precision Number - Digits of precision; required for DecimalTypes
- type
Scale Number - Digits to right of decimal; Required for DecimalTypes
- type
Text String - Full data type specification as SQL/catalogString text
CleanRoomAssetViewColumnMask, CleanRoomAssetViewColumnMaskArgs
- Function
Name string - The full name of the column mask SQL UDF
- Using
Column List<string>Names - 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'
- Function
Name string - The full name of the column mask SQL UDF
- Using
Column []stringNames - 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'
- function
Name String - The full name of the column mask SQL UDF
- using
Column List<String>Names - 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'
- function
Name string - The full name of the column mask SQL UDF
- using
Column string[]Names - 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'
- function_
name str - The full name of the column mask SQL UDF
- using_
column_ Sequence[str]names - 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'
- function
Name String - The full name of the column mask SQL UDF
- using
Column List<String>Names - 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'
CleanRoomAssetViewLocalDetails, CleanRoomAssetViewLocalDetailsArgs
- Local
Name string
- Local
Name string
- local
Name String
- local
Name string
- local_
name str
- local
Name String
CleanRoomAssetVolumeLocalDetails, CleanRoomAssetVolumeLocalDetailsArgs
- Local
Name string
- Local
Name string
- local
Name String
- local
Name string
- local_
name str
- local
Name String
Import
As of Pulumi v1.5, resources can be imported through configuration.
hcl
import {
id = clean_room_name,name,asset_type
to = databricks_clean_room_asset.this
}
If you are using an older version of Pulumi, import the resource using the pulumi import
command as follows:
$ pulumi import databricks:index/cleanRoomAsset:CleanRoomAsset databricks_clean_room_asset clean_room_name,name,asset_type
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- databricks pulumi/pulumi-databricks
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
databricks
Terraform Provider.