Skip to main content
Version: Next

ActorVersionCollectionClientAsync

Sub-client for the Actor version collection.

Provides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method on the ActorClientAsync class.

Hierarchy

Index

Methods

Properties

Methods

__init__

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

  • Initialize the resource client.

    Parameters

    • keyword-onlybase_url: str

      API base URL.

    • keyword-onlypublic_base_url: str

      Public CDN base URL.

    • keyword-onlyhttp_client: HttpClientAsync

      HTTP client for making requests.

    • keyword-onlyresource_path: str

      Resource endpoint path (e.g., 'actors', 'datasets').

    • keyword-onlyclient_registry: ClientRegistryAsync

      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

create

  • async create(*, version_number, build_tag, env_vars, apply_env_vars_to_build, source_type, source_files, git_repo_url, tarball_url, github_gist_url, timeout): Version

  • Create a new Actor version.

    https://docs.apify.com/api/v2#/reference/actors/version-collection/create-version

    Parameters

    • keyword-onlyversion_number: str

      Major and minor version of the Actor (e.g. 1.0).

    • optionalkeyword-onlybuild_tag: str | None = None

      Tag that is automatically set to the latest successful build of the current version.

    • optionalkeyword-onlyenv_vars: list[dict[str, Any]] | None = None

      Environment variables that will be available to the Actor run process, and optionally also to the build process. See the API docs for their exact structure.

    • optionalkeyword-onlyapply_env_vars_to_build: bool | None = None

      Whether the environment variables specified for the Actor run will also be set to the Actor build process.

    • keyword-onlysource_type: VersionSourceType

      What source type is the Actor version using.

    • optionalkeyword-onlysource_files: list[dict[str, Any]] | None = None

      Source code comprised of multiple files, each an item of the array. Required when source_type is 'SOURCE_FILES'. See the API docs for the exact structure.

    • optionalkeyword-onlygit_repo_url: str | None = None

      The URL of a Git repository from which the source code will be cloned. Required when source_type is 'GIT_REPO'.

    • optionalkeyword-onlytarball_url: str | None = None

      The URL of a tarball or a zip archive from which the source code will be downloaded. Required when source_type is 'TARBALL'.

    • optionalkeyword-onlygithub_gist_url: str | None = None

      The URL of a GitHub Gist from which the source will be downloaded. Required when source_type is 'GITHUB_GIST'.

    • optionalkeyword-onlytimeout: Timeout = 'short'

      Timeout for the API HTTP request.

    Returns Version

    The created Actor version.

iterate

  • async iterate(*, timeout): AsyncIterator[Version]

  • Iterate over the available Actor versions.

    The underlying API endpoint does not support pagination, so this method performs a single API call and yields the items from its response. If the endpoint returns more items than fit in one response (the API caps the page size), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more versions than the cap.

    https://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions

    Parameters

    • optionalkeyword-onlytimeout: Timeout = 'short'

      Timeout for the API HTTP request.

    Returns AsyncIterator[Version]

list

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options