Skip to main content

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(): dict | None

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

    • keyword-onlybuild_tag: str | None = None

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

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

    • keyword-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: ActorSourceType | None = None

      What source type is the Actor version using.

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

      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.

    • keyword-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 `ActorSourceType.GIT_REPO`.

    • keyword-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 `ActorSourceType.TARBALL`.

    • keyword-onlygithub_gist_url: str | None = None

      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

Page Options