DatasetCollectionClient

Sub-client for manipulating datasets.

Hierarchy

• ResourceCollectionClient
  • DatasetCollectionClient

Index

Methods

• __init__
• get_or_create
• list

Methods

__init__

• __init__(args, kwargs): None

• Overrides ResourceCollectionClient.__init__

  Initialize the DatasetCollectionClient with the passed arguments.

  ---

  Parameters

  • args: Any

  • kwargs: Any

  Returns None

get_or_create

• get_or_create(*, name): Dict

• Retrieve a named dataset, or create a new one when it doesn't exist.

  https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset

  ---

  Parameters

  • optionalkeyword-onlyname: Optional[str] = None

    The name of the dataset to retrieve or create.

  Returns Dict

  dict: The retrieved or newly-created dataset.

list

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

• List the available datasets.

  https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets

  ---

  Parameters

  • optionalkeyword-onlyunnamed: Optional[bool] = None

    Whether to include unnamed datasets in the list

  • optionalkeyword-onlylimit: Optional[int] = None

    How many datasets to retrieve

  • optionalkeyword-onlyoffset: Optional[int] = None

    What dataset to include as first when retrieving the list

  • optionalkeyword-onlydesc: Optional[bool] = None

    Whether to sort the datasets in descending order based on their modification date

  Returns ListPage

  ListPage: The list of available datasets matching the specified filters.