Storage¶
-
class
vidispine.storage.Storage(client)¶ Manages storages
-
add_storage_method(storage_id: str, method_id: str, params: dict) → Dict[str, Any]¶ Adds a new access method to the storage.
- Parameters
storage_id – The id of the storage to add the method to.
method_id – The id of the method to add to the storage.
params – Optional query params.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
create(metadata: dict) → Dict[str, Any]¶ Creates a new storage.
- Parameters
metadata – Metadata (storage document) to create the storage with.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
delete(storage_id: str, params: Optional[dict] = None) → None¶ Deletes the storage.
- Parameters
storage_id – The id of the storage to delete.
params – Optional query params.
-
get(storage_id: str) → Dict[str, Any]¶ Retrieves a specific storage.
- Parameters
storage_id – The id of the storage to get.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
get_storage_method(storage_id: str, method_id: str, params: Optional[dict] = None) → Dict[str, Any]¶ Retrieves the access methods configured on a specific storage.
- Parameters
storage_id – The id of the storage with the method to get.
method_id – The id of the method to update.
params – Optional query params.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
list(params: Optional[dict] = None) → Dict[str, Any]¶ Lists the storages that have been configured.
- Parameters
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
update(storage_id: str, metadata: dict) → Dict[str, Any]¶ Updates an existing storage.
- Parameters
storage_id – The id of the storage to get.
metadata – Metadata (storage document) of the storage to update.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
update_storage_method(storage_id: str, method_id: str, params: dict) → Dict[str, Any]¶ Updates an existing access method on a storage.
- Parameters
storage_id – The id of the storage with the method to update.
method_id – The id of the method to update.
params – Optional query params.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-