Skip to main content

ActorVersionClient

apify_client.clients.ActorVersionClient

Sub-client for manipulating a single actor version.

Index

Methods

Methods

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

  • get(): Optional[Dict]

update

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

  • Update the actor version with specified fields.

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

    Parameters

    • build_tag: Optional[str] = Noneoptionalkeyword-only

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

    • env_vars: Optional[List[Dict]] = Noneoptionalkeyword-only

      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.

    • apply_env_vars_to_build: Optional[bool] = Noneoptionalkeyword-only

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

    • source_type: Optional[ActorSourceType] = Noneoptionalkeyword-only

      What source type is the actor version using.

    • source_files: Optional[List[Dict]] = Noneoptionalkeyword-only

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

    • git_repo_url: Optional[str] = Noneoptionalkeyword-only

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

    • tarball_url: Optional[str] = Noneoptionalkeyword-only

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

    • github_gist_url: Optional[str] = Noneoptionalkeyword-only

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

    Returns Dict

    The updated actor version