Storage

Base class for storages.

Hierarchy

• Storage
  • RequestQueue
  • KeyValueStore
  • Dataset

Index

Methods

• drop
• open
• storage_object

Properties

• id
• name
• storage_object

Methods

drop

• async drop(): None

• Overrides RequestManager.drop

  Drop the storage, removing it from the underlying storage client and clearing the cache.

  ---

  Returns None

open

• async open(*, id, name, configuration, storage_client): Storage

• Overrides Storage.open

  Open a storage, either restore existing or create a new one.

  ---

  Parameters

  • optionalkeyword-onlyid: str | None = None

    The storage ID.

  • optionalkeyword-onlyname: str | None = None

    The storage name.

  • optionalkeyword-onlyconfiguration: Configuration | None = None

    Configuration object used during the storage creation or restoration process.

  • optionalkeyword-onlystorage_client: StorageClient | None = None

    Underlying storage client to use. If not provided, the default global storage client from the service locator will be used.

  Returns Storage

storage_object

• storage_object(storage_object): None

• Set the full storage object.

  ---

  Parameters

  • storage_object: StorageMetadata

  Returns None

Properties

id

id: str

Get the storage ID.

name

name: str | None

Get the storage name.

storage_object

storage_object: StorageMetadata

Get the full storage object.