Skip to main content

BuildCollectionClient

Sub-client for the Actor build collection.

Provides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the ApifyClient class.

Hierarchy

ResourceClient
- BuildCollectionClient

Index

Methods

Properties

resource_id

Methods

init

__init__(*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params): None

Overrides ResourceClient.__init__
Initialize the resource client.
Parameters
- keyword-onlybase_url: str
  API base URL.
- keyword-onlypublic_base_url: str
  Public CDN base URL.
- keyword-onlyhttp_client: HttpClient
  HTTP client for making requests.
- keyword-onlyresource_path: str
  Resource endpoint path (e.g., 'actors', 'datasets').
- keyword-onlyclient_registry: ClientRegistry
  Bundle of client classes for dependency injection.
- optionalkeyword-onlyresource_id: str | None = None
  Optional resource ID for single-resource clients.
- optionalkeyword-onlyparams: dict | None = None
  Optional default parameters for all requests.
Returns None

list

list(*, limit, offset, desc): ListOfBuilds

List all Actor builds.

List all Actor builds, either of a single Actor, or all user's Actors, depending on where this client was initialized from.

https://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds https://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list
Parameters
- optionalkeyword-onlylimit: int | None = None
  How many builds to retrieve.
- optionalkeyword-onlyoffset: int | None = None
  What build to include as first when retrieving the list.
- optionalkeyword-onlydesc: bool | None = None
  Whether to sort the builds in descending order based on their start date.
Returns ListOfBuilds
The retrieved Actor builds.

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options

Hide Inherited

__init__
list
resource_id