gateway.models package

Submodules

gateway.models.data module

class gateway.models.data.Data(*, key: str | None = None, base64Value: str | None = None)[source]

Bases: BaseModel

base64Value: str | None
key: str | None

gateway.models.data_policy module

class gateway.models.data_policy.DataPolicy(*, actions: List[str], priority: int, condition: str, mask: bool, filter: bool, name: str, version: str, type: str, tags: List[str], description: str, owner: str, layer: str, policy: Policy)[source]

Bases: BaseModel

actions: List[str]
condition: str
description: str
filter: bool
layer: str
mask: bool
name: str
owner: str
policy: Policy
priority: int
tags: List[str]
type: str
version: str

gateway.models.dataset module

class gateway.models.dataset.Column(*, name: str, dataType: str)[source]

Bases: BaseModel

dataType: str
name: str
class gateway.models.dataset.Dataset(*, id: str, fullyQualifiedName: str, name: str, version: float, updatedAt: int, updatedBy: str, href: str, service: Service, serviceType: str, depot: str, collection: str, dataset: str, tags: List[Tag], columns: List[Column])[source]

Bases: BaseModel

collection: str
columns: List[Column]
dataset: str
depot: str
fullyQualifiedName: str
href: str
id: str
name: str
service: Service
serviceType: str
tags: List[Tag]
updatedAt: int
updatedBy: str
version: float
class gateway.models.dataset.Service(*, id: str, type: str, name: str, fullyQualifiedName: str, deleted: bool, href: str)[source]

Bases: BaseModel

deleted: bool
fullyQualifiedName: str
href: str
id: str
name: str
type: str
class gateway.models.dataset.Tag(*, labelType: str, state: str, tagFQN: str)[source]

Bases: BaseModel

labelType: str
state: str
tagFQN: str

gateway.models.decision module

class gateway.models.decision.Decision(*, dataset: Dataset | None = None, user: User | None = None, masks: Dict[str, Mask] | None = None, filter: List[Filter] | None = None)[source]

Bases: BaseModel

dataset: Dataset | None
filter: List[Filter] | None
masks: Dict[str, Mask] | None
user: User | None
class gateway.models.decision.User(*, match: str | None = None, name: str, tags: List[str] | None = None)[source]

Bases: BaseModel

match: str | None
name: str
tags: List[str] | None

gateway.models.filter module

class gateway.models.filter.Filter(*, column: str | None = None, operator: str | None = None, value: str | None = None, valueFrom: ValueFrom | None = None, supportedDataTypes: List[str] | None = None)[source]

Bases: BaseModel

column: str | None
operator: str | None
supported_data_types: List[str] | None
value: str | None
value_from: ValueFrom | None
class gateway.models.filter.ValueFrom(*, user_attribute: str)[source]

Bases: BaseModel

user_attribute: str

gateway.models.mask module

class gateway.models.mask.Mask(*, operator: str, pass_through: MaskPassThrough | None = None, hash: MaskHash | None = None, redact: Dict[str, Any] | None = None, bucket_number: MaskBucketNumber | None = None, bucket_date: MaskBucketDate | None = None, rand_pattern: MaskRandPattern | None = None, rand_regexify: MaskRandRegexify | None = None, regex_replace: MaskRegexReplace | None = None, supportedDataTypes: List[str] | None = None)[source]

Bases: BaseModel

bucket_date: MaskBucketDate | None
bucket_number: MaskBucketNumber | None
hash: MaskHash | None
operator: str
pass_through: MaskPassThrough | None
rand_pattern: MaskRandPattern | None
rand_regexify: MaskRandRegexify | None
redact: Dict[str, Any] | None
regex_replace: MaskRegexReplace | None
supported_data_types: List[str] | None
class gateway.models.mask.MaskBucketDate(*, precision: str)[source]

Bases: BaseModel

precision: str
class gateway.models.mask.MaskBucketNumber(*, buckets: List[int])[source]

Bases: BaseModel

buckets: List[int]
class gateway.models.mask.MaskHash(*, algo: str)[source]

Bases: BaseModel

algo: str
class gateway.models.mask.MaskPassThrough[source]

Bases: BaseModel

class gateway.models.mask.MaskRandPattern(*, pattern: str)[source]

Bases: BaseModel

pattern: str
class gateway.models.mask.MaskRandRegexify(*, pattern: str)[source]

Bases: BaseModel

pattern: str
class gateway.models.mask.MaskRegexReplace(*, pattern: str, replacement: str)[source]

Bases: BaseModel

pattern: str
replacement: str

gateway.models.policy module

class gateway.models.policy.Policy(*, data: PolicyData)[source]

Bases: BaseModel

data: PolicyData

gateway.models.policy_data module

class gateway.models.policy_data.ColumnSelector(*, column: str | None = None, policyName: str | None = None, masks: List[str] | None = None, tags: List[str] | None = None)[source]

Bases: BaseModel

column: str | None
masks: List[str] | None
policyName: str | None
tags: List[str] | None
class gateway.models.policy_data.PolicyData(*, priority: int, type: str, selector: Selector | None = None, mask: Mask | None = None, filters: List[Filter] | None = None, name: str | None = None, description: str | None = None, depot: str | None = None, collection: str | None = None, dataset: str | None = None)[source]

Bases: BaseModel

collection: str | None
dataset: str | None
depot: str | None
description: str | None
filters: List[Filter] | None
mask: Mask | None
name: str | None
priority: int
selector: Selector | None
type: str
class gateway.models.policy_data.Selector(*, user: UserSelector | None = None, column: ColumnSelector | None = None)[source]

Bases: BaseModel

column: ColumnSelector | None
user: UserSelector | None
class gateway.models.policy_data.UserSelector(*, match: str, tags: List[str])[source]

Bases: BaseModel

match: str
tags: List[str]

Module contents