DataverseConfig Class

Configuration settings for Dataverse client operations.

Constructor

DataverseConfig(language_code: int = 1033, http_retries: int | None = None, http_backoff: float | None = None, http_timeout: float | None = None, log_config: 'LogConfig' | None = None, operation_context: OperationContext | None = None)

Parameters

Name Description
language_code
int

LCID (Locale ID) for localized labels and messages. Default is 1033 (English - United States).

Default value: 1033
http_retries
int

Optional maximum number of retry attempts for transient HTTP errors. Reserved for future use.

Default value: None
http_backoff

Optional backoff multiplier (in seconds) between retry attempts. Reserved for future use.

Default value: None
http_timeout

Optional request timeout in seconds. Reserved for future use.

Default value: None
log_config

Optional local HTTP diagnostics logging configuration. When provided, all HTTP requests and responses are logged to timestamped .log files with automatic redaction of sensitive headers.

Default value: None
operation_context

Optional caller-defined context object appended to the outbound User-Agent header as a parenthesized comment. Intended for plugin/tool attribution.

Default value: None

Methods

from_env

Create a configuration instance with default settings.

from_env

Create a configuration instance with default settings.

from_env() -> DataverseConfig

Returns

Type Description

Configuration instance with default values.

Attributes

http_backoff

http_backoff: float | None = None

http_retries

http_retries: int | None = None

http_timeout

http_timeout: float | None = None

language_code

language_code: int = 1033

log_config

log_config: 'LogConfig' | None = None

operation_context

operation_context: OperationContext | None = None