BaseKeyValueStoreCollectionClient

Abstract base class for key-value store collection clients.

This collection client handles operations that involve multiple instances of a given resource type.

Hierarchy

• BaseKeyValueStoreCollectionClient
  • KeyValueStoreCollectionClient

Index

Methods

• get_or_create
• list

Methods

get_or_create

• async get_or_create(*, id, name, schema): KeyValueStoreMetadata

• Retrieve an existing key-value store by its name or ID, or create a new one if it does not exist.

  ---

  Parameters

  • keyword-onlyid: str | None = None

    Optional ID of the key-value store to retrieve or create. If provided, the method will attempt to find a key-value store with the ID.

  • keyword-onlyname: str | None = None

    Optional name of the key-value store resource to retrieve or create. If provided, the method will attempt to find a key-value store with this name.

  • keyword-onlyschema: dict | None = None

    Optional schema for the key-value store resource to be created.

  Returns KeyValueStoreMetadata

  Metadata object containing the information of the retrieved or created key-value store.

list

• async list(*, unnamed, limit, offset, desc): KeyValueStoreListPage

• List the available key-value stores.

  ---

  Parameters

  • keyword-onlyunnamed: bool = False

    Whether to list only the unnamed key-value stores.

  • keyword-onlylimit: int | None = None

    Maximum number of key-value stores to return.

  • keyword-onlyoffset: int | None = None

    Number of key-value stores to skip from the beginning of the list.

  • keyword-onlydesc: bool = False

    Whether to sort the key-value stores in descending order.

  Returns KeyValueStoreListPage

  The list of available key-value stores matching the specified filters.