ActorEnvVarClient

apify_client.clients.ActorEnvVarClient

Sub-client for manipulating a single actor environment variable.

Index

Methods

• delete
• get
• update

Methods

delete

• delete(): None

• Delete the actor environment variable.

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

  ---

  Returns None

get

• get(): Optional[Dict]

• Return information about the actor environment variable.

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

  ---

  Returns Optional[Dict]

  The retrieved actor environment variable data

update

• update(*, is_secret, name, value): Dict

• Update the actor environment variable with specified fields.

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

  ---

  Parameters

  • is_secret: Optional[bool] = Noneoptionalkeyword-only

    Whether the environment variable is secret or not

  • name: strkeyword-only

    The name of the environment variable

  • value: strkeyword-only

    The value of the environment variable

  Returns Dict

  The updated actor environment variable