snowflake.core.notebook.Notebook

class snowflake.core.notebook.Notebook(*, name: Annotated[str, Strict(strict=True)], version: Annotated[str, Strict(strict=True)] | None = None, fromLocation: Annotated[str, Strict(strict=True)] | None = None, main_file: Annotated[str, Strict(strict=True)] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None, default_version: Annotated[str, Strict(strict=True)] | None = None, query_warehouse: Annotated[str, Strict(strict=True)] | None = None, created_on: datetime | None = None, database_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, schema_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, owner: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, owner_role_type: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, url_id: Annotated[str, Strict(strict=True)] | None = None, title: Annotated[str, Strict(strict=True)] | None = None, default_packages: Annotated[str, Strict(strict=True)] | None = None, user_packages: Annotated[str, Strict(strict=True)] | None = None, runtime_name: Annotated[str, Strict(strict=True)] | None = None, compute_pool: Annotated[str, Strict(strict=True)] | None = None, import_urls: List[Annotated[str, Strict(strict=True)]] | None = None, external_access_integrations: List[Annotated[str, Strict(strict=True)]] | None = None, external_access_secrets: Annotated[str, Strict(strict=True)] | None = None, idle_auto_shutdown_time_seconds: Annotated[int, Strict(strict=True)] | None = None, default_version_details: VersionDetails | None = None, last_version_details: VersionDetails | None = None, live_version_location_uri: Annotated[str, Strict(strict=True)] | None = None, budget: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None)

Bases: BaseModel

A model object representing the Notebook resource.

Constructs an object of type Notebook with the provided properties.

Parameters:

  • name (str) – Name of the notebook

  • version (str, optional) – User specified version alias

  • from_location (str, optional) – Location to copy the file from. This must be a Snowflake stage location.

  • main_file (str, optional) – Name + path of the file for the Notebook

  • comment (str, optional) – user comment associated to an object in the dictionary

  • default_version (str, optional) – The default version name of a file based entity.

  • query_warehouse (str, optional) – Warehouse against which the queries issued by the Streamlit app are run against

  • created_on (datetime, optional) – Date and time when the notebook was created.

  • database_name (str, optional) – Database in which the notebook is stored

  • schema_name (str, optional) – Schema in which the notebook is stored

  • owner (str, optional) – Role that owns the notebook

  • owner_role_type (str, optional) – The type of role that owns the notebook

  • url_id (str, optional) – Unique ID associated with the notebook object.

  • title (str, optional) – User facing title of the Streamlit app or an Organization Profile

  • default_packages (str, optional) – Default packages of the notebook

  • user_packages (str, optional) – User packages of the notebook

  • runtime_name (str, optional) – The runtime to run the Streamlit or Notebook on. If this is not set, the warehouse is assumed

  • compute_pool (str, optional) – Compute pool name where the snowservice runs

  • import_urls (List[str], optional) – List of urls

  • external_access_integrations (List[str], optional) – List of external access integrations attached to this function

  • external_access_secrets (str, optional) – Secrets to be used with this function for external access

  • idle_auto_shutdown_time_seconds (int, optional) – Sets the time in seconds for when to shutdown an idle Notebook.

  • default_version_details (VersionDetails, optional)

  • last_version_details (VersionDetails, optional)

  • live_version_location_uri (str, optional) – The current version location

  • budget (str, optional) – Name of the budget if the notebook is monitored by a budget

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → Notebook

Create an instance of Notebook from a dict.

classmethod from_json(json_str: str) → Notebook

Create an instance of Notebook from a JSON string.

to_dict(hide_readonly_properties: bool = False) → Dict[str, Any]

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → Dict[str, Any]

Return the dictionary representation of the model without readonly properties.

to_json() → str

Returns the JSON representation of the model using alias.

to_str() → str

Returns the string representation of the model using alias.

Language: English