KeyValueStoreCollectionClient

Sub-client for manipulating key-value stores.

Hierarchy

• ResourceCollectionClient
  • KeyValueStoreCollectionClient

Index

Methods

• __init__
• get_or_create
• list

Methods

__init__

• __init__(args, kwargs): None

• Overrides ResourceCollectionClient.__init__

  Initialize the KeyValueStoreCollectionClient with the passed arguments.

  ---

  Parameters

  • args: Any

  • kwargs: Any

  Returns None

get_or_create

• get_or_create(*, name): Dict

• Retrieve a named key-value store, or create a new one when it doesn't exist.

  https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store

  ---

  Parameters

  • optionalkeyword-onlyname: Optional[str] = None

    The name of the key-value store to retrieve or create.

  Returns Dict

  dict: The retrieved or newly-created key-value store.

list

• list(*, unnamed, limit, offset, desc): ListPage

• List the available key-value stores.

  https://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores

  ---

  Parameters

  • optionalkeyword-onlyunnamed: Optional[bool] = None

    Whether to include unnamed key-value stores in the list

  • optionalkeyword-onlylimit: Optional[int] = None

    How many key-value stores to retrieve

  • optionalkeyword-onlyoffset: Optional[int] = None

    What key-value store to include as first when retrieving the list

  • optionalkeyword-onlydesc: Optional[bool] = None

    Whether to sort the key-value stores in descending order based on their modification date

  Returns ListPage

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