Skip to content

settings

ArkSIASettingsService

Bases: ArkService

Source code in ark_sdk_python/services/sia/settings/ark_sia_settings_service.py 
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class ArkSIASettingsService(ArkService):
    def __init__(self, isp_auth: ArkISPAuth) -> None:
        super().__init__(isp_auth)
        self.__isp_auth = isp_auth
        self.__client: ArkISPServiceClient = ArkISPServiceClient.from_isp_auth(
            isp_auth=self.__isp_auth,
            service_name='dpa',
            refresh_connection_callback=self.__refresh_sia_auth,
        )

    def __refresh_sia_auth(self, client: ArkISPServiceClient) -> None:
        ArkISPServiceClient.refresh_client(client, self.__isp_auth)

    def setting(self, get_setting: ArkSIASettingsGetSetting) -> ArkSIASettingsSettingTypes:
        """
        Get SIA setting.

        Args:
            get_setting (ArkSIASettingsGetSetting): The setting to get.

        Raises:
            ArkServiceException: If an error occurs while getting the settings.

        Returns:
            ArkSIASettings: The retrieved SIA settings.
        """
        self._logger.info('Getting SIA settings')
        response: Response = self.__client.get(SETTING_PATH.format(feature_name=get_setting.feature_name.value))
        if response.status_code != HTTPStatus.OK:
            raise ArkServiceException(f'Failed to get SIA settings - [{response.status_code}] - [{response.text}]')
        try:
            return FEATURE_NAME_TO_SETTING[get_setting.feature_name].model_validate(response.json()['feature_conf'])
        except (ValidationError, JSONDecodeError, KeyError) as ex:
            self._logger.exception(f'Failed to parse get settings response [{str(ex)}] - [{response.text}]')
            raise ArkServiceException(f'Failed to parse get settings response [{str(ex)}]') from ex

    def set_setting(self, set_setting: ArkSIASettingsSetSetting) -> ArkSIASettingsSettingTypes:
        """
        Set SIA settings.

        Args:
            set_setting (ArkSIASettingsSetSetting): The new SIA setting.

        Raises:
            ArkServiceException: If there is an error setting the SIA setting.

        Returns:
            ArkSIASettings: The new SIA setting.
        """
        self._logger.info(f'Setting SIA setting [{set_setting.feature_name}]')
        response: Response = self.__client.put(
            SETTING_PATH.format(feature_name=set_setting.feature_name.value),
            json=set_setting.setting.model_dump(exclude_none=True, by_alias=True),
        )
        if response.status_code != HTTPStatus.OK:
            raise ArkServiceException(f'Failed to set SIA setting - [{response.status_code}] - [{response.text}]')
        return set_setting.setting

    def list_settings(self, list_settings: ArkSIASettingsListSettings) -> ArkSIASettings:
        """
        Get SIA settings.

        Args:
            list_settings (ArkSIASettingsListSettings): The settings to list.

        Raises:
            ArkServiceException: If an error occurs while getting the settings.

        Returns:
            ArkSIASettings: The retrieved SIA settings.
        """
        self._logger.info('Getting SIA settings')
        response: Response = self.__client.get(SETTINGS_PATH, params=list_settings.model_dump())
        if response.status_code != HTTPStatus.OK:
            raise ArkServiceException(f'Failed to get SIA settings - [{response.status_code}] - [{response.text}]')
        try:
            return ArkSIASettings.model_validate_json(response.text)
        except (ValidationError, JSONDecodeError, KeyError) as ex:
            self._logger.exception(f'Failed to parse get settings response [{str(ex)}] - [{response.text}]')
            raise ArkServiceException(f'Failed to parse get settings response [{str(ex)}]') from ex

    def set_settings(self, set_settings: ArkSIASettingsSetSettings) -> ArkSIASettings:
        """
        Set SIA settings.

        Args:
            set_settings (ArkSIASettingsSetSettings): The new SIA settings.

        Raises:
            ArkServiceException: If there is an error setting the SIA settings.

        Returns:
            ArkSIASettings: The new SIA settings.
        """
        self._logger.info('Setting SIA settings')
        response: Response = self.__client.patch(SETTINGS_PATH, json=set_settings.model_dump(exclude_none=True, by_alias=True))
        if response.status_code != HTTPStatus.OK:
            raise ArkServiceException(f'Failed to set SIA settings - [{response.status_code}] - [{response.text}]')
        return self.list_settings(ArkSIASettingsListSettings())

    @staticmethod
    @overrides
    def service_config() -> ArkServiceConfig:
        return SERVICE_CONFIG

list_settings(list_settings)

Get SIA settings.

Parameters:

Name Type Description Default
list_settings ArkSIASettingsListSettings

The settings to list.

 required

Raises:

Type Description
ArkServiceException

If an error occurs while getting the settings.

Returns:

Name Type Description
ArkSIASettings ArkSIASettings

The retrieved SIA settings.
Source code in ark_sdk_python/services/sia/settings/ark_sia_settings_service.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def list_settings(self, list_settings: ArkSIASettingsListSettings) -> ArkSIASettings:
    """
    Get SIA settings.

    Args:
        list_settings (ArkSIASettingsListSettings): The settings to list.

    Raises:
        ArkServiceException: If an error occurs while getting the settings.

    Returns:
        ArkSIASettings: The retrieved SIA settings.
    """
    self._logger.info('Getting SIA settings')
    response: Response = self.__client.get(SETTINGS_PATH, params=list_settings.model_dump())
    if response.status_code != HTTPStatus.OK:
        raise ArkServiceException(f'Failed to get SIA settings - [{response.status_code}] - [{response.text}]')
    try:
        return ArkSIASettings.model_validate_json(response.text)
    except (ValidationError, JSONDecodeError, KeyError) as ex:
        self._logger.exception(f'Failed to parse get settings response [{str(ex)}] - [{response.text}]')
        raise ArkServiceException(f'Failed to parse get settings response [{str(ex)}]') from ex

set_setting(set_setting)

Set SIA settings.

Parameters:

Name Type Description Default
set_setting ArkSIASettingsSetSetting

The new SIA setting.

 required

Raises:

Type Description
ArkServiceException

If there is an error setting the SIA setting.

Returns:

Name Type Description
ArkSIASettings ArkSIASettingsSettingTypes

The new SIA setting.
Source code in ark_sdk_python/services/sia/settings/ark_sia_settings_service.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def set_setting(self, set_setting: ArkSIASettingsSetSetting) -> ArkSIASettingsSettingTypes:
    """
    Set SIA settings.

    Args:
        set_setting (ArkSIASettingsSetSetting): The new SIA setting.

    Raises:
        ArkServiceException: If there is an error setting the SIA setting.

    Returns:
        ArkSIASettings: The new SIA setting.
    """
    self._logger.info(f'Setting SIA setting [{set_setting.feature_name}]')
    response: Response = self.__client.put(
        SETTING_PATH.format(feature_name=set_setting.feature_name.value),
        json=set_setting.setting.model_dump(exclude_none=True, by_alias=True),
    )
    if response.status_code != HTTPStatus.OK:
        raise ArkServiceException(f'Failed to set SIA setting - [{response.status_code}] - [{response.text}]')
    return set_setting.setting

set_settings(set_settings)

Set SIA settings.

Parameters:

Name Type Description Default
set_settings ArkSIASettingsSetSettings

The new SIA settings.

 required

Raises:

Type Description
ArkServiceException

If there is an error setting the SIA settings.

Returns:

Name Type Description
ArkSIASettings ArkSIASettings

The new SIA settings.
Source code in ark_sdk_python/services/sia/settings/ark_sia_settings_service.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
def set_settings(self, set_settings: ArkSIASettingsSetSettings) -> ArkSIASettings:
    """
    Set SIA settings.

    Args:
        set_settings (ArkSIASettingsSetSettings): The new SIA settings.

    Raises:
        ArkServiceException: If there is an error setting the SIA settings.

    Returns:
        ArkSIASettings: The new SIA settings.
    """
    self._logger.info('Setting SIA settings')
    response: Response = self.__client.patch(SETTINGS_PATH, json=set_settings.model_dump(exclude_none=True, by_alias=True))
    if response.status_code != HTTPStatus.OK:
        raise ArkServiceException(f'Failed to set SIA settings - [{response.status_code}] - [{response.text}]')
    return self.list_settings(ArkSIASettingsListSettings())

setting(get_setting)

Get SIA setting.

Parameters:

Name Type Description Default
get_setting ArkSIASettingsGetSetting

The setting to get.

 required

Raises:

Type Description
ArkServiceException

If an error occurs while getting the settings.

Returns:

Name Type Description
ArkSIASettings ArkSIASettingsSettingTypes

The retrieved SIA settings.
Source code in ark_sdk_python/services/sia/settings/ark_sia_settings_service.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
def setting(self, get_setting: ArkSIASettingsGetSetting) -> ArkSIASettingsSettingTypes:
    """
    Get SIA setting.

    Args:
        get_setting (ArkSIASettingsGetSetting): The setting to get.

    Raises:
        ArkServiceException: If an error occurs while getting the settings.

    Returns:
        ArkSIASettings: The retrieved SIA settings.
    """
    self._logger.info('Getting SIA settings')
    response: Response = self.__client.get(SETTING_PATH.format(feature_name=get_setting.feature_name.value))
    if response.status_code != HTTPStatus.OK:
        raise ArkServiceException(f'Failed to get SIA settings - [{response.status_code}] - [{response.text}]')
    try:
        return FEATURE_NAME_TO_SETTING[get_setting.feature_name].model_validate(response.json()['feature_conf'])
    except (ValidationError, JSONDecodeError, KeyError) as ex:
        self._logger.exception(f'Failed to parse get settings response [{str(ex)}] - [{response.text}]')
        raise ArkServiceException(f'Failed to parse get settings response [{str(ex)}]') from ex