genvid.sdk.SettingsAPI

class genvid.sdk.SettingsAPI(client: ClusterAPI)

Bases: object

client

An HTTP client used for the connection.

get_schema(schema: str)

Get the specified schema.

Parameters:

schema – The schema file.

Returns:

get_settings_schema() → str

Get the schema for settings.

set_settings_schema(schema: dict)

Update the schema for settings.

get_default_settings() → dict

Get the default settings.

Returns:

A dictionary of settings.

get_settings() → dict

Get the settings.

Returns:

A dictionary of settings.

get_settings_validation() → List[str]

Get the settings validation.

Returns:

A list of warning messages.

set_settings(settings: dict)

Set multiple configuration settings.

Parameters:

settings – The settings used for configuration. Values default to empty.

class settings.SettingsAPI

Implementation of genvid.sdk.SettingsAPI