""" Anonymization.
Do not edit this file by hand.
This is generated by parsing api.html service doc.
"""
from ambra_sdk.exceptions.service import FilterNotFound
from ambra_sdk.exceptions.service import InUse
from ambra_sdk.exceptions.service import InvalidCondition
from ambra_sdk.exceptions.service import InvalidField
from ambra_sdk.exceptions.service import InvalidSortField
from ambra_sdk.exceptions.service import InvalidSortOrder
from ambra_sdk.exceptions.service import MissingFields
from ambra_sdk.exceptions.service import NotFound
from ambra_sdk.exceptions.service import NotHash
from ambra_sdk.exceptions.service import NotPermitted
from ambra_sdk.service.query import QueryO
from ambra_sdk.service.query import AsyncQueryO
from ambra_sdk.service.query import QueryOPSF
from ambra_sdk.service.query import AsyncQueryOPSF
class Anonymization:
"""Anonymization."""
def __init__(self, api):
self._api = api
[docs] def list(
self,
account_id,
):
"""List.
:param account_id: uuid of the account
"""
request_data = {
'account_id': account_id,
}
errors_mapping = {}
errors_mapping[('FILTER_NOT_FOUND', None)] = FilterNotFound('The filter can not be found. The error_subtype will hold the filter UUID')
errors_mapping[('INVALID_CONDITION', None)] = InvalidCondition('The condition is not support. The error_subtype will hold the filter expression this applies to')
errors_mapping[('INVALID_FIELD', None)] = InvalidField('The field is not valid for this object. The error_subtype will hold the filter expression this applies to')
errors_mapping[('INVALID_SORT_FIELD', None)] = InvalidSortField('The field is not valid for this object. The error_subtype will hold the field name this applies to')
errors_mapping[('INVALID_SORT_ORDER', None)] = InvalidSortOrder('The sort order for the field is invalid. The error_subtype will hold the field name this applies to')
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The account can not be found')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to view anonymization profiles in this account')
query_data = {
'api': self._api,
'url': '/anonymization/list',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
query_data['paginated_field'] = 'anonymization_profiles'
return QueryOPSF(**query_data)
[docs] def add(
self,
account_id,
name,
rules,
):
"""Add.
:param account_id: uuid of the account to add them to
:param name: Name of the anonymization profile
:param rules: A JSON hash of anonymization rules to apply to retrieved studies
"""
request_data = {
'account_id': account_id,
'name': name,
'rules': rules,
}
errors_mapping = {}
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The account was not found. The error_subtype holds the type of object not found')
errors_mapping[('NOT_HASH', None)] = NotHash('The rules field is not a hash')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to add an anonymization profile to the account')
query_data = {
'api': self._api,
'url': '/anonymization/add',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return QueryO(**query_data)
[docs] def set(
self,
uuid,
name=None,
rules=None,
):
"""Set.
:param uuid: The anonymization profile uuid
:param name: Name of the anonymization profile (optional)
:param rules: A JSON hash of anonymization rules to apply to retrieved studies (optional)
"""
request_data = {
'name': name,
'rules': rules,
'uuid': uuid,
}
errors_mapping = {}
errors_mapping[('IN_USE', None)] = InUse('The anonymization profile is connected to an account, its rule set cannot be changed')
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The anonymization profile can not be found')
errors_mapping[('NOT_HASH', None)] = NotHash('The rules field is not a hash')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to edit the anonymization profile')
query_data = {
'api': self._api,
'url': '/anonymization/set',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return QueryO(**query_data)
[docs] def get(
self,
uuid,
):
"""Get.
:param uuid: The anonymization profile uuid
"""
request_data = {
'uuid': uuid,
}
errors_mapping = {}
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The anonymization profile can not be found')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to view the anonymization profile')
query_data = {
'api': self._api,
'url': '/anonymization/get',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return QueryO(**query_data)
[docs] def delete(
self,
uuid,
):
"""Delete.
:param uuid: The anonymization profile uuid
"""
request_data = {
'uuid': uuid,
}
errors_mapping = {}
errors_mapping[('IN_USE', None)] = InUse('The anonymization profile is connected to an account and cannot be removed')
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The anonymization profile can not be found')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to delete the anonymization profile')
query_data = {
'api': self._api,
'url': '/anonymization/delete',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return QueryO(**query_data)
class AsyncAnonymization:
"""AsyncAnonymization."""
def __init__(self, api):
self._api = api
[docs] def list(
self,
account_id,
):
"""List.
:param account_id: uuid of the account
"""
request_data = {
'account_id': account_id,
}
errors_mapping = {}
errors_mapping[('FILTER_NOT_FOUND', None)] = FilterNotFound('The filter can not be found. The error_subtype will hold the filter UUID')
errors_mapping[('INVALID_CONDITION', None)] = InvalidCondition('The condition is not support. The error_subtype will hold the filter expression this applies to')
errors_mapping[('INVALID_FIELD', None)] = InvalidField('The field is not valid for this object. The error_subtype will hold the filter expression this applies to')
errors_mapping[('INVALID_SORT_FIELD', None)] = InvalidSortField('The field is not valid for this object. The error_subtype will hold the field name this applies to')
errors_mapping[('INVALID_SORT_ORDER', None)] = InvalidSortOrder('The sort order for the field is invalid. The error_subtype will hold the field name this applies to')
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The account can not be found')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to view anonymization profiles in this account')
query_data = {
'api': self._api,
'url': '/anonymization/list',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
query_data['paginated_field'] = 'anonymization_profiles'
return AsyncQueryOPSF(**query_data)
[docs] def add(
self,
account_id,
name,
rules,
):
"""Add.
:param account_id: uuid of the account to add them to
:param name: Name of the anonymization profile
:param rules: A JSON hash of anonymization rules to apply to retrieved studies
"""
request_data = {
'account_id': account_id,
'name': name,
'rules': rules,
}
errors_mapping = {}
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The account was not found. The error_subtype holds the type of object not found')
errors_mapping[('NOT_HASH', None)] = NotHash('The rules field is not a hash')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to add an anonymization profile to the account')
query_data = {
'api': self._api,
'url': '/anonymization/add',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return AsyncQueryO(**query_data)
[docs] def set(
self,
uuid,
name=None,
rules=None,
):
"""Set.
:param uuid: The anonymization profile uuid
:param name: Name of the anonymization profile (optional)
:param rules: A JSON hash of anonymization rules to apply to retrieved studies (optional)
"""
request_data = {
'name': name,
'rules': rules,
'uuid': uuid,
}
errors_mapping = {}
errors_mapping[('IN_USE', None)] = InUse('The anonymization profile is connected to an account, its rule set cannot be changed')
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The anonymization profile can not be found')
errors_mapping[('NOT_HASH', None)] = NotHash('The rules field is not a hash')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to edit the anonymization profile')
query_data = {
'api': self._api,
'url': '/anonymization/set',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return AsyncQueryO(**query_data)
[docs] def get(
self,
uuid,
):
"""Get.
:param uuid: The anonymization profile uuid
"""
request_data = {
'uuid': uuid,
}
errors_mapping = {}
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The anonymization profile can not be found')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to view the anonymization profile')
query_data = {
'api': self._api,
'url': '/anonymization/get',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return AsyncQueryO(**query_data)
[docs] def delete(
self,
uuid,
):
"""Delete.
:param uuid: The anonymization profile uuid
"""
request_data = {
'uuid': uuid,
}
errors_mapping = {}
errors_mapping[('IN_USE', None)] = InUse('The anonymization profile is connected to an account and cannot be removed')
errors_mapping[('MISSING_FIELDS', None)] = MissingFields('A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields')
errors_mapping[('NOT_FOUND', None)] = NotFound('The anonymization profile can not be found')
errors_mapping[('NOT_PERMITTED', None)] = NotPermitted('You are not permitted to delete the anonymization profile')
query_data = {
'api': self._api,
'url': '/anonymization/delete',
'request_data': request_data,
'errors_mapping': errors_mapping,
'required_sid': True,
}
return AsyncQueryO(**query_data)