Interface SharedDataObject

The time when this data object is added to the share, in epoch milliseconds.

Username of the sharer.

Whether to enable cdf or indicate if cdf is enabled on the shared object.

A user-provided comment when adding the data object to the share.

The content of the notebook file when the data object type is NOTEBOOK_FILE. This should be base64 encoded. Required for adding a NOTEBOOK_FILE, optional for updating, ignored for other types.

The type of the data object.

Whether to enable or disable sharing of data history. If not specified, the default is DISABLED.

A fully qualified name that uniquely identifies a data object. For example, a table's fully qualified name is in the format of <catalog>.<schema>.<table>,

Array of partitions for the shared data.

A user-provided alias name for table-like data objects within the share.

Use this field for table-like objects (for example: TABLE, VIEW, MATERIALIZED_VIEW, STREAMING_TABLE, FOREIGN_TABLE). For non-table objects (for example: VOLUME, MODEL, NOTEBOOK_FILE, FUNCTION), use string_shared_as instead.

Important: For non-table objects, this field must be omitted entirely.

Format: Must be a 2-part name <schema_name>.<table_name> (e.g., "sales_schema.orders_table")

• Both schema and table names must contain only alphanumeric characters and underscores
• No periods, spaces, forward slashes, or control characters are allowed within each part
• Do not include the catalog name (use 2 parts, not 3)

Behavior:

• If not provided, the service automatically generates the alias as <schema>.<table> from the object's original name
• If you don't want to specify this field, omit it entirely from the request (do not pass an empty string)
• The shared_as name must be unique within the share

Examples:

• Valid: "analytics_schema.customer_view"
• Invalid: "catalog.analytics_schema.customer_view" (3 parts not allowed)
• Invalid: "analytics-schema.customer-view" (hyphens not allowed)

The start version associated with the object. This allows data providers to control the lowest object version that is accessible by clients. If specified, clients can query snapshots or changes for versions >= start_version. If not specified, clients can only query starting from the version of the object at the time it was added to the share.

NOTE: The start_version should be <= the current version of the object.

One of: ACTIVE, PERMISSION_DENIED.

A user-provided alias name for non-table data objects within the share.

Use this field for non-table objects (for example: VOLUME, MODEL, NOTEBOOK_FILE, FUNCTION). For table-like objects (for example: TABLE, VIEW, MATERIALIZED_VIEW, STREAMING_TABLE, FOREIGN_TABLE), use shared_as instead.

Important: For table-like objects, this field must be omitted entirely.

Format:

• For VOLUME: Must be a 2-part name <schema_name>.<volume_name> (e.g., "data_schema.ml_models")
• For FUNCTION: Must be a 2-part name <schema_name>.<function_name> (e.g., "udf_schema.calculate_tax")
• For MODEL: Must be a 2-part name <schema_name>.<model_name> (e.g., "models.prediction_model")
• For NOTEBOOK_FILE: Should be the notebook file name (e.g., "analysis_notebook.py")
• All names must contain only alphanumeric characters and underscores
• No periods, spaces, forward slashes, or control characters are allowed within each part

Behavior:

• If not provided, the service automatically generates the alias from the object's original name
• If you don't want to specify this field, omit it entirely from the request (do not pass an empty string)
• The string_shared_as name must be unique for objects of the same type within the share

Examples:

• Valid for VOLUME: "data_schema.training_data"
• Valid for FUNCTION: "analytics.calculate_revenue"
• Invalid: "catalog.data_schema.training_data" (3 parts not allowed for volumes)
• Invalid: "data-schema.training-data" (hyphens not allowed)