ActorEnvVarClientAsync

Sub-client for managing a specific Actor environment variable.

Provides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance via an appropriate method on the ActorVersionClientAsync class.

Hierarchy

• ResourceClientAsync
  • ActorEnvVarClientAsync

Index

Methods

• __init__
• delete
• get
• update

Properties

• resource_id

Methods

__init__

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

• Overrides ResourceClientAsync.__init__

  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

delete

• async delete(): None

• Delete the Actor environment variable.

  https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable

  ---

  Returns None

get

• async get(): EnvVar | None

• Return information about the Actor environment variable.

  https://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable

  ---

  Returns EnvVar | None

  The retrieved Actor environment variable data.

update

• async update(*, is_secret, name, value): EnvVar

• Update the Actor environment variable with specified fields.

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

  ---

  Parameters

  • optionalkeyword-onlyis_secret: bool | None = None

    Whether the environment variable is secret or not.

  • keyword-onlyname: str

    The name of the environment variable.

  • keyword-onlyvalue: str

    The value of the environment variable.

  Returns EnvVar

  The updated Actor environment variable.

Properties

resource_id

resource_id: str | None

Inherited from ResourceClientBase.resource_id

Get the resource ID.