snowflake.core.external_volume.ExternalVolumeResource¶
- class snowflake.core.external_volume.ExternalVolumeResource(name: str, collection_class: ExternalVolumeCollectionBase)¶
Bases:
ExternalVolumeResourceBase
Represents a reference to a Snowflake external volume.
With this external volume reference, you can fetch information about external volumes, as well as perform certain actions on them.
Attributes
- root¶
The Root object this reference belongs to.
Methods
- drop(if_exists: bool | None = None) None ¶
Delete an external volume.
- Parameters:
if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.
- drop_async(if_exists: bool | None = None) PollingOperation[None] ¶
An asynchronous version of
drop()
.Refer to
PollingOperation
for more information on asynchronous execution and the return type.
- fetch() ExternalVolume ¶
Fetch an external volume.
- fetch_async() PollingOperation[ExternalVolume] ¶
An asynchronous version of
fetch()
.Refer to
PollingOperation
for more information on asynchronous execution and the return type.
- undrop() None ¶
Undrop an external volume.
- undrop_async() PollingOperation[None] ¶
An asynchronous version of
undrop()
.Refer to
PollingOperation
for more information on asynchronous execution and the return type.