Skip to main content

ActorVersionClient

Sub-client for managing a specific Actor version.

Provides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an appropriate method on the ActorClient 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: 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

delete

  • delete(): None

env_var

  • Retrieve the client for the specified environment variable of this Actor version.

    Parameters

    • env_var_name: str

      The name of the environment variable for which to retrieve the resource client.

    Returns ActorEnvVarClient

    The resource client for the specified Actor environment variable.

env_vars

get

update

  • update(*, build_tag, env_vars, apply_env_vars_to_build, source_type, source_files, git_repo_url, tarball_url, github_gist_url): Version

  • Update the Actor version with specified fields.

    https://docs.apify.com/api/v2#/reference/actors/version-object/update-version

    Parameters

    • 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] | 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.

    • optionalkeyword-onlysource_type: VersionSourceType | None = None

      What source type is the Actor version using.

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

      Source code comprised of multiple files, each an item of the array. Required when source_type is VersionSourceType.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 VersionSourceType.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 VersionSourceType.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 VersionSourceType.GITHUB_GIST.

    Returns Version

    The updated Actor version.

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options