Configuration Endpoints

class graphdatascience.procedure_surface.api.config_endpoints.ConfigEndpoints

abstract property defaults: DefaultsEndpoints

Endpoints for default configuration values.

abstract property limits: LimitsEndpoints

Endpoints for configuration limits.

class graphdatascience.procedure_surface.api.config_endpoints.DefaultsEndpoints

abstract list(username: str | None = None, key: str | None = None) → dict[str, Any]

List configured default configuration values.

Parameters:

• key (str | None) – str | None (default=None) List only the default value for the given key.

• username (str | None) – str | None, default=None List only default values for the given user.

Return type:

dict[str, Any]

Returns: dict[str, Any]

A dictionary containing the default configuration values.

abstract set(key: str, value: Any, username: str | None = None) → None

Configure a new default configuration value.

Parameters:

• key (str) – str The configuration key for which the default value is being set.

• value (Any) – Any The value to set as the default for the given key.

• username (str | None) – str | None, default=None If set, the configuration will be set for the given user.

Return type:

None

Returns: None

class graphdatascience.procedure_surface.api.config_endpoints.LimitsEndpoints

abstract list(username: str | None = None, key: str | None = None) → dict[str, Any]

List configured configuration limits.

Parameters:

• key (str | None) – str | None (default=None) List only the limits for the given key.

• username (str | None) – str | None, default=None List only liomits for the given user.

Return type:

dict[str, Any]

Returns: dict[str, Any]

A dictionary containing the configuration limits.

abstract set(key: str, value: Any, username: str | None = None) → None

Configure a new limit for a configuration value.

Parameters:

• key (str) – str The configuration key for which the limit is being set.

• value (Any) – Any The value to set as the limit for the given key.

• username (str | None) – str | None, default=None If set, the limit will be set for the given user.

Return type:

None

Returns: None