Skip to main content

ActorVersionClientAsync

Async sub-client for manipulating a single Actor version.

Hierarchy

Index

Methods

Properties

Methods

__init__

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

  • Initialize a new instance.

    Parameters

    • keyword-onlybase_url: str

      Base URL of the API server.

    • keyword-onlyroot_client: ApifyClientAsync

      The ApifyClientAsync instance under which this resource client exists.

    • keyword-onlyhttp_client: HTTPClientAsync

      The HTTPClientAsync instance to be used in this client.

    • optionalkeyword-onlyresource_id: str | None = None

      ID of the manipulated resource, in case of a single-resource client.

    • keyword-onlyresource_path: str

      Path to the resource's endpoint on the API server.

    • optionalkeyword-onlyparams: dict | None = None

      Parameters to include in all requests from this client.

    Returns None

delete

  • async 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 ActorEnvVarClientAsync

env_vars

get

  • async get(): dict | None

update

  • async 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

    • 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: ActorSourceType | 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 ActorSourceType.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 ActorSourceType.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 ActorSourceType.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 ActorSourceType.GITHUB_GIST.

    Returns dict

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

params

params: dict

resource_id

resource_id: str | None

root_client

root_client: ApifyClient | ApifyClientAsync

url

url: str
Page Options