snowflake.core.stage.StageΒΆ

class snowflake.core.stage.Stage(*, name: Annotated[str, Strict(strict=True)], kind: Annotated[str, Strict(strict=True)] | None = 'PERMANENT', url: Annotated[str, Strict(strict=True)] | None = None, endpoint: Annotated[str, Strict(strict=True)] | None = None, storage_integration: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None, credentials: Credentials | None = None, encryption: StageEncryption | None = None, directory_table: StageDirectoryTable | None = None, created_on: datetime | None = None, has_credentials: Annotated[bool, Strict(strict=True)] | None = None, has_encryption_key: Annotated[bool, Strict(strict=True)] | None = None, owner: Annotated[str, Strict(strict=True)] | None = None, owner_role_type: Annotated[str, Strict(strict=True)] | None = None, region: Annotated[str, Strict(strict=True)] | None = None, cloud: Annotated[str, Strict(strict=True)] | None = None)ΒΆ

Bases: BaseModel

A model object representing the Stage resource.

Constructs an object of type Stage with the provided properties.

Parameters:

  • name (str) – A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

  • kind (str, default 'PERMANENT') – Specifies whether the stage is permanent or temporary.

  • url (str, optional) – URL for the external stage; blank for an internal stage.

  • endpoint (str, optional) – The S3-compatible API endpoint associated with the stage; always NULL for stages that are not S3-compatible.

  • storage_integration (str, optional) – A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

  • comment (str, optional) – Specifies a comment for the stage.

  • credentials (Credentials, optional)

  • encryption (StageEncryption, optional)

  • directory_table (StageDirectoryTable, optional)

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

  • has_credentials (bool, optional) – Indicates that the external stage has access credentials; always false for an internal stage.

  • has_encryption_key (bool, optional) – Indicates that the external stage contains encrypted files; always false for an internal stage.

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

  • owner_role_type (str, optional) – The type of role that owns the object, either ROLE or DATABASE_ROLE. If a Snowflake Native App owns the object, the value is APPLICATION. Snowflake returns NULL if you delete the object because a deleted object does not have an owner role.

  • region (str, optional) – Region where the stage is located.

  • cloud (str, optional) – Cloud provider; always NULL for an internal stage.

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) β†’ StageΒΆ

Create an instance of Stage from a dict.

classmethod from_json(json_str: str) β†’ StageΒΆ

Create an instance of Stage 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