KeyValueStoreCollectionClient
Hierarchy
- ResourceCollectionClient
- KeyValueStoreCollectionClient
Index
Methods
Properties
Methods
__init__
Initialize a new instance.
Parameters
keyword-onlybase_url: str
Base URL of the API server.
keyword-onlyroot_client: ApifyClient
The ApifyClient instance under which this resource client exists.
keyword-onlyhttp_client: HTTPClient
The HTTPClient instance to be used in this client.
optionalkeyword-onlyresource_id: str | None = None
ID of the manipulated resource, in case of a single-resource client.
keyword-onlyresource_path: str
Path to the resource's endpoint on the API server.
optionalkeyword-onlyparams: dict | None = None
Parameters to include in all requests from this client.
Returns None
get_or_create
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: str | None = None
The name of the key-value store to retrieve or create.
optionalkeyword-onlyschema: dict | None = None
The schema of the key-value store.
Returns dict
list
List the available key-value stores.
Parameters
optionalkeyword-onlyunnamed: bool | None = None
Whether to include unnamed key-value stores in the list.
optionalkeyword-onlylimit: int | None = None
How many key-value stores to retrieve.
optionalkeyword-onlyoffset: int | None = None
What key-value store to include as first when retrieving the list.
optionalkeyword-onlydesc: bool | None = None
Whether to sort the key-value stores in descending order based on their modification date.
Returns ListPage[dict]
Sub-client for manipulating key-value stores.