snowflake.core.external_volume.ExternalVolumeΒΆ

class snowflake.core.external_volume.ExternalVolume(*, name: Annotated[str, Strict(strict=True)], storage_locations: List[StorageLocation], allow_writes: Annotated[bool, Strict(strict=True)] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None, created_on: datetime | 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)ΒΆ

Bases: BaseModel

A model object representing the ExternalVolume resource.

Constructs an object of type ExternalVolume with the provided properties.

Parameters:

  • name (str) – String that specifies the identifier (the name) for the external volume; must be unique in your account.

  • storage_locations (List[StorageLocation]) – Set of named cloud storage locations in different regions and, optionally, cloud platforms.

  • allow_writes (bool, optional) – Specifies whether write operations are allowed for the external volume; must be set to TRUE for Iceberg tables that use Snowflake as the catalog.

  • comment (str, optional) – String (literal) that specifies a comment for the external volume.

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

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

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

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

Create an instance of ExternalVolume from a dict.

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

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