Skip to main content

ActorEnvVarClientAsync

Async sub-client for manipulating a single Actor environment variable.

Hierarchy

ResourceClientAsync
- ActorEnvVarClientAsync

Index

Methods

Properties

Methods

init

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

Overrides ActorJobBaseClientAsync.__init__
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

Delete the Actor environment variable.

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

get

async get(): dict | None

Return information about the Actor environment variable.

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

update

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

Hide Inherited

__init__
delete
get
update
http_client
params
resource_id
root_client
url