Skip to main content

WherobotsConfig

Immutable configuration for the Wherobots Jobs client.

Parameters

str | None
default:"None"
Wherobots API key.
str | None
default:"None"
Default deployment region (e.g. "aws-us-west-2").
str | None
default:"None"
Deprecated and ignored. Will be removed in a future release.
str
default:"'wherobots-jobs'"
Deprecated and ignored. Will be removed in a future release.
str
default:"'https://api.cloud.wherobots.com'"
Wherobots API base URL (must use HTTPS).
str | None
default:"None"
Runtime version; None lets the organization’s preset decide.
int
default:"30"
HTTP request timeout in seconds.
str | None
default:"None"
Upstream X-Wherobots-Client chain for callers that embed this SDK (e.g. the Airflow provider). The SDK appends its own hop to the right of it, so the origin client stays leftmost. Advisory only — it never affects authentication.
str | None
default:"None"
Workload-identity token mounted in Wherobots notebook and job pods. Used for auth only when no api_key is set.

from_env()

Build configuration from environment variables with optional overrides. Explicit parameters take priority over environment variables. Empty-string env vars are treated as unset.

Parameters

str | None
default:"None"
Override for WHEROBOTS_API_KEY.
str | None
default:"None"
Override for WHEROBOTS_REGION.
str | None
default:"None"
Deprecated and ignored, like WHEROBOTS_S3_BUCKET. Will be removed in a future release.
str | None
default:"None"
Deprecated and ignored, like WHEROBOTS_S3_PREFIX. Will be removed in a future release.
str | None
default:"None"
Override for WHEROBOTS_API_BASE_URL.
str | None
default:"None"
Override for WHEROBOTS_VERSION.
int | None
default:"None"
Override for WHEROBOTS_REQUEST_TIMEOUT_SECONDS.
str | None
default:"None"
Override for WHEROBOTS_CLIENT_CHAIN — the upstream X-Wherobots-Client chain this SDK appends its own hop to.
str | None
default:"None"
Override for WHEROBOTS_ID_TOKEN_PATH, which Wherobots notebook and job pods set.

Returns

WherobotsConfig
A validated WherobotsConfig instance.

Raises

  • WherobotsConfigError: If the timeout env var is not a valid integer, or if validation in __post_init__ fails.